Modernize var syntax, including type info where known#285
Merged
Conversation
Updates `<var>...</var>` to instead use modern respec `|...|`, and in
most cases, on first definition of a variable, includes type of variable
in a suffix to `...` in the definition.
Links IDL method arguments in the definition to the argument variable's
detail by also wrapping those argument names in `|...|`.
Includes a couple other minor changes: uses `minus` instead of `-` in
algorithms in a couple places.
Replaces a couple instances of "source buffer" with "{{SourceBuffer}}"
for improved linkage.
Note, the MSE-in-Workers initial draft PR (w3c#282) contained some similar
changes to lines only relevant to that draft, requiring manual rebase of
this onto it once that landed.
wolenetz
force-pushed
the
modernize_vars
branch
from
a8ced83 to
3775bc8
Compare
See [1] for PR review comment motivating this change. ReSpec gets confused if two distinct entities are named the same, in this case, "error" variable in the endOfStream() method algorithm is now distinguished versus the "error parameter" of the end of stream algorithm. [1] w3c#285 (review)
Member
Author
|
Note, 3775bc8 was a force push of the result of manual rebase over the top of the now-landed PR#282. |
Member
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates
<var>...</var>to instead use modern respec|...|, and inmost cases, on first definition of a variable, includes type of variable
as a suffix to
...in the definition.Links IDL method arguments in the definition to the argument variable's
detail by also wrapping those argument names in
|...|.Includes a couple other minor changes: uses
minusinstead of-inalgorithms in a couple places.
Replaces a couple instances of "source buffer" with "{{SourceBuffer}}"
for improved linkage.
Note, the MSE-in-Workers initial draft PR (#282) contains some similar
changes to lines only relevant to that draft, and will likely need
rebasing and manual merge resolution on top of this once this lands.
Preview | Diff