Change terminology used for input output parameters pt 2 #5324
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 tasks
chriseth
reviewed
Nov 14, 2018
docs/assembly.rst
Outdated
| @@ -291,10 +291,10 @@ In the grammar, opcodes are represented as pre-defined identifiers. | |||
| | | | | 8 byte value, ``this`` is the current contract's address | | |||
| | | | | as a 20 byte value and ``s`` is a big-endian 256-bit value | | |||
| +-------------------------+-----+---+-----------------------------------------------------------------+ | |||
| | call(g, a, v, in, | | F | call contract at address a with input mem[in...(in+insize)) | | |||
There was a problem hiding this comment.
I don't think we should call these "function parameters", because we do not call a function. I would leave it as it is.
chriseth
reviewed
Nov 14, 2018
docs/layout-of-source-files.rst
Outdated
| @@ -276,7 +276,7 @@ functions, annotate conditions for formal verification, and provide a | |||
| function. | |||
|
|
|||
| In the following example we document the title of the contract, the explanation | |||
| for the two input parameters and two returned values. | |||
| for the two function parameters and two return types. | |||
There was a problem hiding this comment.
types does not seem right here. I think we should either say return parameters or return values (which is slightly wrong, but perhaps better to understand).
chriseth
reviewed
Nov 14, 2018
docs/types.rst
Outdated
| @@ -253,7 +253,7 @@ Send is the low-level counterpart of ``transfer``. If the execution fails, the c | |||
| In order to interface with contracts that do not adhere to the ABI, | |||
| or to get more direct control over the encoding, | |||
| the functions ``call``, ``delegatecall`` and ``staticcall`` are provided. | |||
| They all take a single ``bytes memory`` argument as input and | |||
| They all take a single ``bytes memory`` function parameter and | |||
There was a problem hiding this comment.
Suggested change
| They all take a single ``bytes memory`` function parameter and | |
| They all take a single ``bytes memory`` parameter and |
("function" is implied)
chriseth
force-pushed
the
docs-input-output-change-types
branch
from
3b1a43a to
f30bd92
Compare
Codecov Report
@@ Coverage Diff @@
## develop #5324 +/- ##
==========================================
Coverage ? 87.99%
==========================================
Files ? 320
Lines ? 32444
Branches ? 3858
==========================================
Hits ? 28549
Misses ? 2590
Partials ? 1305
|
chriseth
force-pushed
the
docs-input-output-change-types
branch
from
f30bd92 to
afdc82f
Compare
chriseth
previously approved these changes
Nov 14, 2018
chriseth
force-pushed
the
docs-input-output-change-types
branch
from
afdc82f to
fa1cb34
Compare
chriseth
approved these changes
Nov 14, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Description
As discussed here #4859 (comment) this first PR changes the terminology previously used for input and output parameters. Hopefully, I got the semantics, explanations and usage correct. Part 1 is here #5323.