Skip to content

Change terminology used for input output parameters pt 2 #5324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 14, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/layout-of-source-files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 variables.

::

Expand Down
2 changes: 1 addition & 1 deletion docs/types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`` parameter and
return the success condition (as a ``bool``) and the returned data
(``bytes memory``).
The functions ``abi.encode``, ``abi.encodePacked``, ``abi.encodeWithSelector``
Expand Down
7 changes: 3 additions & 4 deletions docs/units-and-global-variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ library has to be updated by an external oracle.
.. note::
The suffix ``years`` has been removed in version 0.5.0 due to the reasons above.

These suffixes cannot be applied to variables. If you want to
interpret some input variable in e.g. days, you can do it in the following way::
These suffixes cannot be applied to variables. For example, if you want to
interpret a function parameter in days, you can in the following way::

function f(uint start, uint daysAfter) public {
if (now >= start + daysAfter * 1 days) {
Expand Down Expand Up @@ -125,7 +125,7 @@ ABI Encoding and Decoding Functions
These encoding functions can be used to craft data for external function calls without actually
calling an external function. Furthermore, ``keccak256(abi.encodePacked(a, b))`` is a way
to compute the hash of structured data (although be aware that it is possible to
craft a "hash collision" using different inputs types).
craft a "hash collision" using different function parameter types).

See the documentation about the :ref:`ABI <ABI>` and the
:ref:`tightly packed encoding <abi_packed_mode>` for details about the encoding.
Expand Down Expand Up @@ -240,4 +240,3 @@ Furthermore, all functions of the current contract are callable directly includi
.. note::
Prior to version 0.5.0, there was a function called ``suicide`` with the same
semantics as ``selfdestruct``.