cerc-io/solidity
10
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Properly capitalise UTF-8/ASCII in the documentation

Browse Source
This commit is contained in:
Alex Beregszaszi 2021-03-24 16:09:00 +00:00
parent 2f36e15009
commit 7ac891600d
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/abi-spec.rst
View File

@ -199,9 +199,9 @@ on the type of ``X`` being
- ``string``: - ``string``:
``enc(X) = enc(enc_utf8(X))``, i.e. ``X`` is utf-8 encoded and this value is interpreted ``enc(X) = enc(enc_utf8(X))``, i.e. ``X`` is UTF-8 encoded and this value is interpreted
as of ``bytes`` type and encoded further. Note that the length used in this subsequent as of ``bytes`` type and encoded further. Note that the length used in this subsequent
encoding is the number of bytes of the utf-8 encoded string, not its number of characters. encoding is the number of bytes of the UTF-8 encoded string, not its number of characters.
- ``uint<M>``: ``enc(X)`` is the big-endian encoding of ``X``, padded on the higher-order - ``uint<M>``: ``enc(X)`` is the big-endian encoding of ``X``, padded on the higher-order
(left) side with zero-bytes such that the length is 32 bytes. (left) side with zero-bytes such that the length is 32 bytes.

4
docs/layout-of-source-files.rst
View File

@ -330,8 +330,8 @@ Single-line comments (``//``) and multi-line comments (``/*...*/``) are possible
.. note:: .. note::
A single-line comment is terminated by any unicode line terminator A single-line comment is terminated by any unicode line terminator
(LF, VF, FF, CR, NEL, LS or PS) in utf8 encoding. The terminator is still part of (LF, VF, FF, CR, NEL, LS or PS) in UTF-8 encoding. The terminator is still part of
the source code after the comment, so if it is not an ascii symbol the source code after the comment, so if it is not an ASCII symbol
(these are NEL, LS and PS), it will lead to a parser error. (these are NEL, LS and PS), it will lead to a parser error.
Additionally, there is another type of comment called a natspec comment, Additionally, there is another type of comment called a natspec comment,

2
docs/yul.rst
View File

@ -688,7 +688,7 @@ We will use a destructuring notation for the AST nodes.
Let G'', L'', mode = E(Gn, L', block) Let G'', L'', mode = E(Gn, L', block)
G'', Ln, L''[$ret1], ..., L''[$retm] G'', Ln, L''[$ret1], ..., L''[$retm]
E(G, L, l: StringLiteral) = G, L, utf8EncodeLeftAligned(l), E(G, L, l: StringLiteral) = G, L, utf8EncodeLeftAligned(l),
where utf8EncodeLeftAligned performs a utf8 encoding of l where utf8EncodeLeftAligned performs a UTF-8 encoding of l
and aligns it left into 32 bytes and aligns it left into 32 bytes
E(G, L, n: HexNumber) = G, L, hex(n) E(G, L, n: HexNumber) = G, L, hex(n)
where hex is the hexadecimal decoding function where hex is the hexadecimal decoding function