Skip to content

Commit 9bce024

Browse files
authored
Merge pull request #12676 from fulldecent/fix-style-guide-typos
Fix typos
2 parents 1698384 + 9d94870 commit 9bce024

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/style-guide.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Style Guide
88
Introduction
99
************
1010

11-
This guide is intended to provide coding conventions for writing solidity code.
11+
This guide is intended to provide coding conventions for writing Solidity code.
1212
This guide should be thought of as an evolving document that will change over
1313
time as useful conventions are found and old conventions are rendered obsolete.
1414

@@ -20,15 +20,15 @@ taken from python's
2020
`pep8 style guide <https://www.python.org/dev/peps/pep-0008/>`_.
2121

2222
The goal of this guide is *not* to be the right way or the best way to write
23-
solidity code. The goal of this guide is *consistency*. A quote from python's
23+
Solidity code. The goal of this guide is *consistency*. A quote from python's
2424
`pep8 <https://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds>`_
2525
captures this concept well.
2626

2727
.. note::
2828

2929
A style guide is about consistency. Consistency with this style guide is important. Consistency within a project is more important. Consistency within one module or function is most important.
3030

31-
But most importantly: **know when to be inconsistent** -- sometimes the style guide just doesn't apply. When in doubt, use your best judgement. Look at other examples and decide what looks best. And don't hesitate to ask!
31+
But most importantly: **know when to be inconsistent** -- sometimes the style guide just doesn't apply. When in doubt, use your best judgment. Look at other examples and decide what looks best. And don't hesitate to ask!
3232

3333

3434
***********
@@ -51,7 +51,7 @@ Mixing tabs and spaces should be avoided.
5151
Blank Lines
5252
===========
5353

54-
Surround top level declarations in solidity source with two blank lines.
54+
Surround top level declarations in Solidity source with two blank lines.
5555

5656
Yes:
5757

@@ -680,7 +680,7 @@ No:
680680
}
681681
682682
For long function declarations, it is recommended to drop each argument onto
683-
it's own line at the same indentation level as the function body. The closing
683+
its own line at the same indentation level as the function body. The closing
684684
parenthesis and opening bracket should be placed on their own line as well at
685685
the same indentation level as the function declaration.
686686

@@ -933,7 +933,7 @@ Permissible:
933933
function shortFunction() public { doSomething(); }
934934
935935
These guidelines for function declarations are intended to improve readability.
936-
Authors should use their best judgement as this guide does not try to cover all
936+
Authors should use their best judgment as this guide does not try to cover all
937937
possible permutations for function declarations.
938938

939939
Mappings
@@ -1023,7 +1023,7 @@ No:
10231023
10241024
* Operators with a higher priority than others can exclude surrounding
10251025
whitespace in order to denote precedence. This is meant to allow for
1026-
improved readability for complex statement. You should always use the same
1026+
improved readability for complex statements. You should always use the same
10271027
amount of whitespace on either side of an operator:
10281028

10291029
Yes:

0 commit comments

Comments
 (0)