diff options
| author | chriseth <c@ethdev.com> | 2016-05-19 07:40:15 +0800 |
|---|---|---|
| committer | chriseth <c@ethdev.com> | 2016-05-19 07:40:15 +0800 |
| commit | cb865fb2b1be9d31b40bbd547c603c2bb81283b1 (patch) | |
| tree | c6d815bd4448c335536d5f8b5a0bd9e5f80ea048 /docs/style-guide.rst | |
| parent | 8efd6dd27a9ae1ccb8391ac326f04dff55129b5f (diff) | |
| parent | 8bd111525560f3819597cfc77f60dc025c3c19eb (diff) | |
| download | dexon-solidity-cb865fb2b1be9d31b40bbd547c603c2bb81283b1.tar.gz dexon-solidity-cb865fb2b1be9d31b40bbd547c603c2bb81283b1.tar.zst dexon-solidity-cb865fb2b1be9d31b40bbd547c603c2bb81283b1.zip | |
Merge pull request #581 from Denton-L/docs-corrections
Minor Corrections to Documentation Content
Diffstat (limited to 'docs/style-guide.rst')
| -rw-r--r-- | docs/style-guide.rst | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst index 02f89bb8..332b1ba6 100644 --- a/docs/style-guide.rst +++ b/docs/style-guide.rst @@ -252,7 +252,7 @@ No:: for (...) { ...;} -For control structures who's body contains a single statement, omitting the +For control structures whose body contains a single statement, omitting the braces is ok *if* the statement is contained on a single line. Yes:: @@ -365,14 +365,14 @@ Yes:: address e, address f ) { - do_something; + doSomething(); } No:: function thisFunctionHasLotsOfArguments(address a, address b, address c, address d, address e, address f) { - do_something; + doSomething(); } function thisFunctionHasLotsOfArguments(address a, @@ -381,7 +381,7 @@ No:: address d, address e, address f) { - do_something; + doSomething(); } function thisFunctionHasLotsOfArguments( @@ -391,7 +391,7 @@ No:: address d, address e, address f) { - do_something; + doSomething(); } If a long function declaration has modifiers, then each modifier should be @@ -405,7 +405,7 @@ Yes:: priced returns (address) { - do_something; + doSomething(); } function thisFunctionNameIsReallyLong( @@ -418,7 +418,7 @@ Yes:: priced returns (address) { - do_something; + doSomething(); } No:: @@ -428,13 +428,13 @@ No:: onlyowner priced returns (address) { - do_something; + doSomething(); } function thisFunctionNameIsReallyLong(address x, address y, address z) public onlyowner priced returns (address) { - do_something; + doSomething(); } function thisFunctionNameIsReallyLong(address x, address y, address z) @@ -442,10 +442,10 @@ No:: onlyowner priced returns (address) { - do_something; + doSomething(); } -For constructor functions on inherited contracts who's bases require arguments, +For constructor functions on inherited contracts whose bases require arguments, it is recommended to drop the base constructors onto new lines in the same manner as modifiers if the function declaration is long or hard to read. |