From 89c99800d01d74d1a8cb4df761cf050680b344a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20=C5=9Aliwak?= Date: Thu, 6 Aug 2020 13:58:14 +0200 Subject: [PATCH] docs: Fix solidity code blocks by using the capitalized name - This only works with `Solidity`, not with `solidity`. --- docs/natspec-format.rst | 4 ++-- docs/using-the-compiler.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/natspec-format.rst b/docs/natspec-format.rst index d4777df31..acb7a35d3 100644 --- a/docs/natspec-format.rst +++ b/docs/natspec-format.rst @@ -46,7 +46,7 @@ The following example shows a contract and a function using all available tags. public. You are welcome to use similar comments for your internal and private functions, but those will not be parsed. -.. code:: solidity +.. code:: Solidity // SPDX-License-Identifier: GPL-3.0 pragma solidity >0.6.10 <0.8.0; @@ -126,7 +126,7 @@ JSON output, for example the end-user client software, may present this to the e For example, some client software will render: -.. code:: solidity +.. code:: Solidity /// @notice This function will multiply `a` by 7 diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst index 9ef1758c1..c1d416dc2 100644 --- a/docs/using-the-compiler.rst +++ b/docs/using-the-compiler.rst @@ -637,7 +637,7 @@ Example Assume that you have the following contract in ``Source.sol``: -.. code-block:: solidity +.. code-block:: Solidity pragma solidity >=0.6.0 <0.6.4; // This will not compile after 0.7.0 @@ -691,7 +691,7 @@ It is recommended to explicitly specify the upgrade modules by using ``--modules The command above applies all changes as shown below. Please review them carefully (the pragmas will have to be updated manually.) -.. code-block:: solidity +.. code-block:: Solidity pragma solidity >0.6.99 <0.8.0; // SPDX-License-Identifier: GPL-3.0