Re: [whatwg/encoding] Editorial: use IDL's this and adopt more Infra (#175)

Ms2ger approved this pull request.



> @@ -1072,14 +1070,13 @@ interface mixin TextDecoderCommon {
 <p>The {{TextDecoderCommon}} interface mixin defines common attributes that are shared between
 {{TextDecoder}} and {{TextDecoderStream}} objects. These objects have an associated
 <dfn id=textdecoder-encoding for=TextDecoderCommon>encoding</dfn>,
-<dfn id=textdecoder-ignore-bom-flag for=TextDecoderCommon>ignore BOM flag</dfn> (initially unset),
-<dfn id=textdecoder-bom-seen-flag for=TextDecoderCommon>BOM seen flag</dfn> (initially unset), and
-<dfn id=textdecoder-error-mode for=TextDecoderCommon>error mode</dfn> (initially
+<dfn id=textdecoder-ignore-bom-flag for=TextDecoderCommon>ignore BOM</dfn> (boolean, initially
+unset), <dfn id=textdecoder-bom-seen-flag for=TextDecoderCommon>BOM seen</dfn> (boolean, initially

```suggestion
false), <dfn id=textdecoder-bom-seen-flag for=TextDecoderCommon>BOM seen</dfn> (boolean, initially
```

> @@ -1072,14 +1070,13 @@ interface mixin TextDecoderCommon {
 <p>The {{TextDecoderCommon}} interface mixin defines common attributes that are shared between
 {{TextDecoder}} and {{TextDecoderStream}} objects. These objects have an associated
 <dfn id=textdecoder-encoding for=TextDecoderCommon>encoding</dfn>,
-<dfn id=textdecoder-ignore-bom-flag for=TextDecoderCommon>ignore BOM flag</dfn> (initially unset),
-<dfn id=textdecoder-bom-seen-flag for=TextDecoderCommon>BOM seen flag</dfn> (initially unset), and
-<dfn id=textdecoder-error-mode for=TextDecoderCommon>error mode</dfn> (initially
+<dfn id=textdecoder-ignore-bom-flag for=TextDecoderCommon>ignore BOM</dfn> (boolean, initially
+unset), <dfn id=textdecoder-bom-seen-flag for=TextDecoderCommon>BOM seen</dfn> (boolean, initially
+unset), and <dfn id=textdecoder-error-mode for=TextDecoderCommon>error mode</dfn> (initially

```suggestion
false), and <dfn id=textdecoder-error-mode for=TextDecoderCommon>error mode</dfn> (initially
```

>  "<code>replacement</code>").
 
-<p>These objects also have an associated
-<dfn id=concept-td-serialize for=TextDecoderCommon>serialize stream</dfn> algorithm, that given a
-<a for=/>stream</a> <var>stream</var>, runs these steps:
+<p>The <dfn id=concept-td-serialize>serialize stream</dfn> algorithm, given a {{TextDecoderCommon}}
+<var>dec</var> and a <a for=/>stream</a> <var>stream</var>, runs these steps:

Nit: "decoder" isn't all that long, and somewhat more readable.

> @@ -1118,17 +1116,16 @@ control.
 <hr>
 
 <p>The <dfn attribute id=dom-textdecoder-encoding for=TextDecoderCommon><code>encoding</code></dfn>
-attribute's getter, when invoked, must return this object's <a for=TextDecoderCommon>encoding</a>'s
+attribute's getter must return <b>this</b>'s <a for=TextDecoderCommon>encoding</a>'s
 <a for=encoding>name</a> in <a>ASCII lowercase</a>.

"in" -> "converted to"?

>  
    <li>
-    <p>If <var>token</var> is <a>end-of-stream</a> and the <a for=TextDecoder>do not flush flag</a>
-    is set, then return <var>output</var>,
-    <a lt="serialize stream" for=TextDecoderCommon>serialized</a>.
+    <p>If <var>token</var> is <a>end-of-stream</a> and <b>this</b>'s
+    <a for=TextDecoder>do not flush</a> is true, then return the result of running
+    <a>serialize stream</a> with <b>this</b> and <var>output</var>.
 
     <p class=note>The way streaming works is to not handle <a>end-of-stream</a> here when the

```suggestion
     <p class=note>The way streaming works is to not handle <a>end-of-stream</a> here when
```

> @@ -1331,7 +1324,7 @@ requires buffering of scalar values.
 </dl>
 
 <p>The <dfn constructor for=TextEncoder id=dom-textencoder><code>TextEncoder()</code></dfn>
-constructor, when invoked, must return a new {{TextEncoder}} object.
+constructor, when invoked, must do nothing.

You removed a bunch of "when invoked"s, but also some remain. What's the policy?

> @@ -2725,8 +2702,8 @@ consumers of content generated with <a>GBK</a>'s <a for=/>encoder</a>.
 
      <li><p>Set the <a>ISO-2022-JP output flag</a>.

Are you planning to remove these flags in a followup?

-- 
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/175#pullrequestreview-241619033