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

@domenic commented on this pull request.

The domintros still reference internal slots without using "this's", but maybe that's fine. The domintros aren't super web-developer friendly right now anyway (they focus mostly on the mapping to internal slots, and not on the web-developer-observable effects of an API). So maybe they should be left for later.

> @@ -1110,16 +1110,20 @@ interface mixin TextDecoderCommon {
 </pre>
 
 <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</dfn> (initially false),
-<dfn id=textdecoder-bom-seen-flag for=TextDecoderCommon>BOM seen</dfn> (initially false), and
-<dfn id=textdecoder-error-mode for=TextDecoderCommon>error mode</dfn> (initially
-"<code>replacement</code>").
+{{TextDecoder}} and {{TextDecoderStream}} objects. These objects have an associated:
+
+<ul class=brief>

This really feels like a definition list to me, but I'm not sure if that'd end up looking right.

> @@ -1158,17 +1164,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
-<a for=encoding>name</a> in <a>ASCII lowercase</a>.
+attribute's getter steps are to return <a>this</a>'s <a for=TextDecoderCommon>encoding</a>'s

Remove "attribute" per latest discussions.

>  
- <li><p>If <var>options</var>'s <code>fatal</code> member is true, then set <var>dec</var>'s
+ <li><p>If <var>options</var>["<code>fatal</code>"] is true, then set <a>this</a>'s

You can cross-link these with `{{TextDecoderOptions/fatal}}`. Same for all other dictionary members. Maybe you'll want to delay that to a follow-up, though.

> @@ -1369,17 +1376,17 @@ requires buffering of scalar values.
 
  <dt><code><var>encoder</var> . <a method=for=TextEncoder lt="encodeInto(source, destination)">encodeInto(<var>source</var>, <var>destination</var>)</a></code>
  <dd><p>Runs the <a>UTF-8 encoder</a> on <var>source</var>, stores the result of that operation into
- <var>destination</var>, and returns the progress made as a dictionary whereby
+ <var>destination</var>, and returns the progress made as an object whereby

```suggestion
 <var>destination</var>, and returns the progress made as an object wherein
```

>  
 <ol>
- <li><p>If <a for=TextDecoder>do not flush</a> is false, set <a for=TextDecoder>decoder</a>
- to a new <a for=TextDecoderCommon>encoding</a>'s <a for=/>decoder</a>,
- <a for=TextDecoder>stream</a> to a new <a for=/>stream</a>, and
- <a for=TextDecoderCommon>BOM seen</a> to false.
+ <li><p>If <a>this</a>'s <a for=TextDecoder>do not flush</a> is false, then set <a>this</a>'s
+ <a for=TextDecoder>decoder</a> to a new <a for=TextDecoderCommon>encoding</a>'s

This for is wrong (preexisting problem)

-- 
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-409406095

Received on Monday, 11 May 2020 18:13:18 UTC