From 4c34adb799c4a4e6685e1ded414053604aa9a1d1 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Thu, 16 Mar 2017 00:42:42 +0000 Subject: Add link to version pragma --- docs/installing-solidity.rst | 2 +- docs/layout-of-source-files.rst | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst index fb405475..e4808801 100644 --- a/docs/installing-solidity.rst +++ b/docs/installing-solidity.rst @@ -280,4 +280,4 @@ Example: 3. a breaking change is introduced - version is bumped to 0.5.0 4. the 0.5.0 release is made -This behaviour works well with the version pragma. +This behaviour works well with the :ref:`version pragma `. diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst index 1e27b7c0..32b806ca 100644 --- a/docs/layout-of-source-files.rst +++ b/docs/layout-of-source-files.rst @@ -7,6 +7,8 @@ and pragma directives. .. index:: ! pragma, version +.. _version_pragma: + Version Pragma ============== -- cgit v1.2.3 From 42f2623cd3650437860604b7bb7117037416e1bb Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Thu, 16 Mar 2017 00:43:25 +0000 Subject: Fix list indentation --- docs/control-structures.rst | 3 ++- docs/index.rst | 2 +- docs/installing-solidity.rst | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/control-structures.rst b/docs/control-structures.rst index 25bf203b..a3af41dd 100644 --- a/docs/control-structures.rst +++ b/docs/control-structures.rst @@ -399,6 +399,7 @@ Currently, Solidity automatically generates a runtime exception in the following #. If you call ``assert`` with an argument that evaluates to false. While a user-provided exception is generated in the following situations: + #. Calling ``throw``. #. Calling ``require`` with an argument that evaluates to ``false``. @@ -411,4 +412,4 @@ did not occur. Because we want to retain the atomicity of transactions, the safe If contracts are written so that ``assert`` is only used to test internal conditions and ``require`` is used in case of malformed input, a formal analysis tool that verifies that the invalid -opcode can never be reached can be used to check for the absence of errors assuming valid inputs. \ No newline at end of file +opcode can never be reached can be used to check for the absence of errors assuming valid inputs. diff --git a/docs/index.rst b/docs/index.rst index fc1a4231..30f71afe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,7 @@ Solidity ======== Solidity is a contract-oriented, high-level language whose syntax is similar to that of JavaScript -and it is designed to target the Ethereum Virtual Machine. +and it is designed to target the Ethereum Virtual Machine (EVM). Solidity is statically typed, supports inheritance, libraries and complex user-defined types among other features. diff --git a/docs/installing-solidity.rst b/docs/installing-solidity.rst index e4808801..1e63f5dd 100644 --- a/docs/installing-solidity.rst +++ b/docs/installing-solidity.rst @@ -250,6 +250,7 @@ The version string in detail ============================ The Solidity version string contains four parts: + - the version number - pre-release tag, usually set to ``develop.YYYY.MM.DD`` or ``nightly.YYYY.MM.DD`` - commit in the format of ``commit.GITHASH`` -- cgit v1.2.3 From b053b6164e3104413cd0d4ce301f56a0914757cc Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Thu, 16 Mar 2017 11:20:39 +0000 Subject: Fix typo (recieve to receive) --- docs/common-patterns.rst | 2 +- docs/contracts.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/common-patterns.rst b/docs/common-patterns.rst index a2d7ce71..5fa84242 100644 --- a/docs/common-patterns.rst +++ b/docs/common-patterns.rst @@ -23,7 +23,7 @@ contract in order to become the "richest", inspired by `King of the Ether `_. In the following contract, if you are usurped as the richest, -you will recieve the funds of the person who has gone on to +you will receive the funds of the person who has gone on to become the new richest. :: diff --git a/docs/contracts.rst b/docs/contracts.rst index 9145f016..2ee04675 100644 --- a/docs/contracts.rst +++ b/docs/contracts.rst @@ -1101,7 +1101,7 @@ Restrictions for libraries in comparison to contracts: - No state variables - Cannot inherit nor be inherited -- Cannot recieve Ether +- Cannot receive Ether (These might be lifted at a later point.) -- cgit v1.2.3