From 7ac891600da1dd7a992465610b24540b611e78ad Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Wed, 24 Mar 2021 16:09:00 +0000 Subject: [PATCH] Properly capitalise UTF-8/ASCII in the documentation --- docs/abi-spec.rst | 4 ++-- docs/layout-of-source-files.rst | 4 ++-- docs/yul.rst | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/abi-spec.rst b/docs/abi-spec.rst index 6e897db50..63a203592 100644 --- a/docs/abi-spec.rst +++ b/docs/abi-spec.rst @@ -199,9 +199,9 @@ on the type of ``X`` being - ``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 - 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``: ``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. diff --git a/docs/layout-of-source-files.rst b/docs/layout-of-source-files.rst index 29d40619c..a0235cfa9 100644 --- a/docs/layout-of-source-files.rst +++ b/docs/layout-of-source-files.rst @@ -330,8 +330,8 @@ Single-line comments (``//``) and multi-line comments (``/*...*/``) are possible .. note:: 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 - the source code after the comment, so if it is not an ascii symbol + (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 (these are NEL, LS and PS), it will lead to a parser error. Additionally, there is another type of comment called a natspec comment, diff --git a/docs/yul.rst b/docs/yul.rst index aff5455e7..27e35cfa0 100644 --- a/docs/yul.rst +++ b/docs/yul.rst @@ -688,7 +688,7 @@ We will use a destructuring notation for the AST nodes. Let G'', L'', mode = E(Gn, L', block) G'', Ln, L''[$ret1], ..., L''[$retm] 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 E(G, L, n: HexNumber) = G, L, hex(n) where hex is the hexadecimal decoding function