aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2017-03-16 20:22:10 +0800
committerGitHub <noreply@github.com>2017-03-16 20:22:10 +0800
commite34a9600f27f7b48fb2473db6bc45377190301b0 (patch)
tree9c35db82330f00dfa36a045a2e4c7f4ebec1df36 /docs
parent6ecfcbb686516690e02e26ef248c842e1de81528 (diff)
parentb053b6164e3104413cd0d4ce301f56a0914757cc (diff)
downloaddexon-solidity-e34a9600f27f7b48fb2473db6bc45377190301b0.tar.gz
dexon-solidity-e34a9600f27f7b48fb2473db6bc45377190301b0.tar.zst
dexon-solidity-e34a9600f27f7b48fb2473db6bc45377190301b0.zip
Merge pull request #1791 from ethereum/docs-fixes
Mostly typo fixes in the documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/common-patterns.rst2
-rw-r--r--docs/contracts.rst2
-rw-r--r--docs/control-structures.rst3
-rw-r--r--docs/index.rst2
-rw-r--r--docs/installing-solidity.rst3
-rw-r--r--docs/layout-of-source-files.rst2
6 files changed, 9 insertions, 5 deletions
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 <https://www.kingoftheether.com/>`_.
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.)
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 8fd30b16..61cff7ac 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 a3e72c5a..a2a3c3da 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``
@@ -280,4 +281,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 <version_pragma>`.
diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst
index 154cd2dc..05708964 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
==============