Re: [whatwg/encoding] Clarify that encoding tokens are scalar values. (#196)

annevk commented on this pull request.

Thanks for doing this! Don't forget to add your name to the Acknowledgments section when addressing the nits.

> @@ -216,15 +216,22 @@ happening.
  <var>encoderDecoderInstance</var> is a <a for=/>decoder</a> instance, and "<code>fatal</code>"
  otherwise.
 
+ <li><p>Assert: If <var>encoderDecoderInstance</var> is an <a for=/>encoder</a> instance,

```suggestion
 <li><p>Assert: if <var>encoderDecoderInstance</var> is an <a for=/>encoder</a> instance,
```

> @@ -216,15 +216,22 @@ happening.
  <var>encoderDecoderInstance</var> is a <a for=/>decoder</a> instance, and "<code>fatal</code>"
  otherwise.
 
+ <li><p>Assert: If <var>encoderDecoderInstance</var> is an <a for=/>encoder</a> instance,
+ <var>token</var> is not a <a>surrogate</a> code point.

```suggestion
 <var>token</var> is not a <a>surrogate</a>.
```

>   <li><p>Let <var>result</var> be the result of running <var>encoderDecoderInstance</var>'s
  <a>handler</a> on <var>input</var> and <var>token</var>.
 
  <li><p>If <var>result</var> is <a>continue</a> or <a>finished</a>, return
  <var>result</var>.
 
  <li><p>Otherwise, if <var>result</var> is one or more
- <a>tokens</a>, <a>push</a>
- <var>result</var> to <var>output</var>.
+ <a>tokens</a>:
+  <ol>
+   <li><p>Assert: If <var>encoderDecoderInstance</var> is a <a for=/>decoder</a>
+   instance, <var>result</var> does not contain any <a>surrogate</a> code points.
+   <li><p><a>Push</a> <var>result</var> to <var>output</var>.
+  </ol>

Can you format this as the following list item? In particular, now the list item contains multiple children, the `<p>` needs to be on its own line. Also it should be "surrogates" (no code points, as that's part of its definition).

> @@ -858,6 +865,10 @@ different format here, to be able to represent ranges.)
 
  <p>The <a>get an encoding</a> algorithm is to be used to turn a <a>label</a> into an
  <a for=/>encoding</a>.
+
+ <p>Standards are to ensure that the streams they pass to the <a for=/>encode</a> and
+ <a>UTF-8 encode</a> algorithms are effectively scalar value streams, i.e. they contain

```suggestion
 <a>UTF-8 encode</a> algorithms are effectively scalar value streams, i.e., they contain
```

> @@ -858,6 +865,10 @@ different format here, to be able to represent ranges.)
 
  <p>The <a>get an encoding</a> algorithm is to be used to turn a <a>label</a> into an
  <a for=/>encoding</a>.
+
+ <p>Standards are to ensure that the streams they pass to the <a for=/>encode</a> and
+ <a>UTF-8 encode</a> algorithms are effectively scalar value streams, i.e. they contain
+ no <a>surrogate</a> code points.

```suggestion
 no <a>surrogates</a>.
```

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/whatwg/encoding/pull/196#pullrequestreview-345207288

Received on Monday, 20 January 2020 10:24:22 UTC