Minor syntax and formatting changes #3337
Conversation
celeduc
commented
Dec 15, 2017
celeduc
commented
- consistent use of quote characters within sample code comments
- Some English syntax errors and typos
docs/contracts.rst
Outdated
| @@ -128,7 +128,7 @@ Visibility and Getters | |||
| Since Solidity knows two kinds of function calls (internal | |||
| ones that do not create an actual EVM call (also called | |||
| a "message call") and external | |||
| ones that do), there are four types of visibilities for | |||
There was a problem hiding this comment.
Please also remove the opening parenthesis above.
There was a problem hiding this comment.
Reverted. Although nested parentheses aren't great, it's the clearest option here.
docs/contracts.rst
Outdated
| /// reentrant calls from within msg.sender.call cannot call f again. | ||
| /// The `return 7` statement assigns 7 to the return value but still | ||
| /// executes the statement `locked = false` in the modifier. | ||
| /// reentrant calls from within "msg.sender.call" cannot call "f" again. |
There was a problem hiding this comment.
The backticks are used to format code, I think it is good to keep them unless you have a compelling reason.
There was a problem hiding this comment.
Which is the standard? There are two different styles in this file.
There was a problem hiding this comment.
Ah I'm sorry, I didn't see that. I would lean slightly towards backticks for code citations (quotes should still be used for anything that is not code). What do you think, @axic?
There was a problem hiding this comment.
I applied this throughout this file with the latest commit.
docs/contracts.rst
Outdated
| @@ -1383,6 +1383,6 @@ It is also possible to extend elementary types in that way:: | |||
| } | |||
|
|
|||
| Note that all library calls are actual EVM function calls. This means that | |||
| if you pass memory or value types, a copy will be performed, even of the | |||
| if you pass ``memory`` or value types, a copy will be performed, even of the | |||
There was a problem hiding this comment.
Here, the term "memory" is not used as the name of something but rather the concept and thus I would not code-format it, same goes for storage below.
wherever a reserved word, function or variable name is used in a comment
