Update index.bs #5
Conversation
Punctuation (space) before "(<text>)". Links to readable, writable, TypeError.
is not entirely clear. An entire write-up could possibly be devoted to the concept of |
There was a problem hiding this comment.
The GenericTransformStream definition is copied from the Encoding Standard (https://encoding.spec.whatwg.org/#interface-mixin-generictransformstream). I intend to eventually move it to a common location in the streams standard, once that has switched to WebIDL.
| @@ -82,9 +82,9 @@ An object that includes {{GenericTransformStream}} has an associated <dfn>transf | |||
| ## Attributes ## {#outgoing-stream-attributes} | |||
|
|
|||
| : <dfn attribute for="GenericTransformStream">readable</dfn> | |||
| :: The `readable` attribute's getter, when invoked, must return this object's transform \[[readable]]. | |||
| :: The `readable` attribute's getter, when invoked, must return this object's transform \[[readable](https://streams.spec.whatwg.org/#rs-class)]. | |||
There was a problem hiding this comment.
We don't usually link to slots. If we did, I think the link should go to https://streams.spec.whatwg.org/#ts-internal-slots.
Also, since it is a slot, it needs double [[]] square brackets.
| The {{CompressionStream}}(format) constructor, when invoked, must run these steps: | ||
| 1. If <dfn for=CompressionStream>format</dfn> is unsupported in CompressionStream, then throw a TypeError. | ||
| The {{CompressionStream}} (format) constructor, when invoked, must run these steps: | ||
| 1. If <dfn for=CompressionStream>format</dfn> is unsupported in CompressionStream, then throw a [TypeError](https://www.ecma-international.org/ecma-262/6.0/#sec-native-error-types-used-in-this-standard-typeerror). |
There was a problem hiding this comment.
I think Bikeshed can auto-link TypeError if we write it like {{TypeError}}. Also, I think it's probably preferable to import it from WebIDL rather than ECMASCRIPT (at least, that it what the encoding standard does).
| 1. Let *cs* be a new CompressionStream object. | ||
| 1. Set *cs*'s *format* to <a for=CompressionStream>format</a>. | ||
| 1. Let *startAlgorithm* be an algorithm that takes no arguments and returns nothing. | ||
| 1. Let *transformAlgorithm* be an algorithm which takes a *chunk* argument and runs the <a>compress and enqueue a chunk</a> algorithm with *cs* and *chunk*. | ||
| 1. Let *flushAlgorithm* be an algorithm which takes no argument and runs the <a>compress flush and enqueue</a> algorithm with *cs*. | ||
| 1. Let *transform* be the result of calling <a abstract-op>CreateTransformStream</a>(*startAlgorithm*, *transformAlgorithm*, *flushAlgorithm*). | ||
| 1. Let *transform* be the result of calling <a abstract-op>CreateTransformStream</a> (*startAlgorithm*, *transformAlgorithm*, *flushAlgorithm*). |
|
Is your interpretation that the document is true and correct as is and that this PR is not necessary? |
|
I think linkifying TypeError is good. Linkifying references to internal slots seems difficult, and I'm not sure it's worth it. I'm used to the style of not having a space before I'm sorry I created the impression that your contributions were not valued. The spec definitely has flaws that need addressing. |
Punctuation (space) before "()". Links to readable, writable, TypeError. Add link to https://ricea.github.io/compression/#compressionstream-format at GitHub page.
Preview | Diff