Skip to content

Commit 1351cbb

Browse files
committed
fix: typo
1 parent ef743aa commit 1351cbb

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

docs/bugs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ List of Known Bugs
77
##################
88

99
Below, you can find a JSON-formatted list of some of the known security-relevant bugs in the
10-
Solidity compiler. The file itself is hosted in the `Github repository
10+
Solidity compiler. The file itself is hosted in the `GitHub repository
1111
<https://github.com/ethereum/solidity/blob/develop/docs/bugs.json>`_.
1212
The list stretches back as far as version 0.3.0, bugs known to be present only
1313
in versions preceding that are not listed.

docs/cheatsheet.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Modifiers
149149
- ``pure`` for functions: Disallows modification or access of state.
150150
- ``view`` for functions: Disallows modification of state.
151151
- ``payable`` for functions: Allows them to receive Ether together with a call.
152-
- ``constant`` for state variables: Disallows assignment (except initialisation), does not occupy storage slot.
152+
- ``constant`` for state variables: Disallows assignment (except initialization), does not occupy storage slot.
153153
- ``immutable`` for state variables: Allows assignment at construction time and is constant when deployed. Is stored in code.
154154
- ``anonymous`` for events: Does not store event signature as topic.
155155
- ``indexed`` for event parameters: Stores the parameter as topic.

docs/contracts/inheritance.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ Constructors
398398

399399
A constructor is an optional function declared with the ``constructor`` keyword
400400
which is executed upon contract creation, and where you can run contract
401-
initialisation code.
401+
initialization code.
402402

403403
Before the constructor code is executed, state variables are initialised to
404404
their specified value if you initialise them inline, or their :ref:`default value<default-value>` if you do not.

docs/contributing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ for the ``evmone`` shared object can be specified via the ``ETH_EVMONE`` environ
128128
If you do not have it installed, you can skip these tests by passing the ``--no-semantic-tests``
129129
flag to ``scripts/soltest.sh``.
130130

131-
The ``evmone`` library should both end with the file name
131+
The ``evmone`` library should end with the file name
132132
extension ``.so`` on Linux, ``.dll`` on Windows systems and ``.dylib`` on macOS.
133133

134134
For running SMT tests, the ``libz3`` library must be installed and locatable
@@ -552,7 +552,7 @@ topics, issues or feature implementations are debated in detail. The invitation
552552

553553
We are also sharing feedback surveys and other content that is relevant to language design in the forum.
554554

555-
If you want to know where the team is standing in terms or implementing new features, you can follow the implementation status in the `Solidity Github project <https://github.com/ethereum/solidity/projects/43>`_.
555+
If you want to know where the team is standing in terms or implementing new features, you can follow the implementation status in the `Solidity GitHub project <https://github.com/ethereum/solidity/projects/43>`_.
556556
Issues in the design backlog need further specification and will either be discussed in a language design call or in a regular team call. You can
557557
see the upcoming changes for the next breaking release by changing from the default branch (`develop`) to the `breaking branch <https://github.com/ethereum/solidity/tree/breaking>`_.
558558

docs/installing-solidity.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,14 @@ and runs it in a new container, passing the ``--help`` argument.
8383
8484
docker run ethereum/solc:stable --help
8585
86-
For example, You can specify release build versions in the tag for the 0.5.4 release.
86+
You can specify release build versions in the tag. For example,
8787

8888
.. code-block:: bash
8989
90-
docker run ethereum/solc:0.5.4 --help
90+
docker run ethereum/solc:0.8.21 --help
9191
9292
To use the Docker image to compile Solidity files on the host machine, mount a
93-
local folder for input and output, and specify the contract to compile. For example.
93+
local folder for input and output, and specify the contract to compile. For example,
9494

9595
.. code-block:: bash
9696
@@ -183,7 +183,7 @@ If you need a specific version of Solidity you can install a
183183
Homebrew formula directly from Github.
184184

185185
View
186-
`solidity.rb commits on Github <https://github.com/ethereum/homebrew-ethereum/commits/master/solidity.rb>`_.
186+
`solidity.rb commits on GitHub <https://github.com/ethereum/homebrew-ethereum/commits/master/solidity.rb>`_.
187187

188188
Copy the commit hash of the version you want and check it out on your machine.
189189

@@ -224,8 +224,8 @@ out-of-the-box but it is also meant to be friendly to third-party tools:
224224
(via git, HTTPS, IPFS or just have it cached locally) and verify hashes of the binaries
225225
after downloading them, you do not have to use HTTPS for the binaries themselves.
226226

227-
The same binaries are in most cases available on the `Solidity release page on Github`_. The
228-
difference is that we do not generally update old releases on the Github release page. This means
227+
The same binaries are in most cases available on the `Solidity release page on GitHub`_. The
228+
difference is that we do not generally update old releases on the GitHub release page. This means
229229
that we do not rename them if the naming convention changes and we do not add builds for platforms
230230
that were not supported at the time of release. This only happens in ``solc-bin``.
231231

@@ -301,7 +301,7 @@ This means that:
301301
.. _IPFS: https://ipfs.io
302302
.. _Swarm: https://swarm-gateways.net/bzz:/swarm.eth
303303
.. _solc-bin: https://github.com/ethereum/solc-bin/
304-
.. _Solidity release page on github: https://github.com/ethereum/solidity/releases
304+
.. _Solidity release page on GitHub: https://github.com/ethereum/solidity/releases
305305
.. _sha3sum: https://github.com/maandree/sha3sum
306306
.. _keccak256() function from ethereumjs-util: https://github.com/ethereumjs/ethereumjs-util/blob/master/docs/modules/_hash_.md#const-keccak256
307307
.. _WebAssembly builds: https://emscripten.org/docs/compiling/WebAssembly.html
@@ -461,11 +461,11 @@ you should fork Solidity and add your personal fork as a second remote:
461461
This method will result in a pre-release build leading to e.g. a flag
462462
being set in each bytecode produced by such a compiler.
463463
If you want to re-build a released Solidity compiler, then
464-
please use the source tarball on the github release page:
464+
please use the source tarball on the GitHub release page:
465465

466466
https://github.com/ethereum/solidity/releases/download/v0.X.Y/solidity_0.X.Y.tar.gz
467467

468-
(not the "Source code" provided by github).
468+
(not the "Source code" provided by GitHub).
469469

470470
Command-Line Build
471471
------------------

docs/internals/optimizer.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ is transformed to
461461
}
462462
463463
This eases the rest of the optimization process because we can ignore
464-
the complicated scoping rules of the for loop initialisation block.
464+
the complicated scoping rules of the for loop initialization block.
465465

466466
.. _var-decl-initializer:
467467

@@ -1196,7 +1196,7 @@ The FullInliner replaces certain calls of certain functions
11961196
by the function's body. This is not very helpful in most cases, because
11971197
it just increases the code size but does not have a benefit. Furthermore,
11981198
code is usually very expensive and we would often rather have shorter
1199-
code than more efficient code. In same cases, though, inlining a function
1199+
code than more efficient code. In some cases, though, inlining a function
12001200
can have positive effects on subsequent optimizer steps. This is the case
12011201
if one of the function arguments is a constant, for example.
12021202

0 commit comments

Comments
 (0)