Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modernize var syntax, including type info where known #285

Merged
merged 2 commits into from
Sep 1, 2021

Conversation

wolenetz
Copy link
Member

@wolenetz wolenetz commented Jul 31, 2021

Updates <var>...</var> to instead use modern respec |...|, and in
most 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 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 (#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

@wolenetz wolenetz requested review from tidoust and mwatson2 July 31, 2021 00:04
Copy link
Member

@tidoust tidoust left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

media-source-respec.html Outdated Show resolved Hide resolved
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.
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)
@wolenetz
Copy link
Member Author

wolenetz commented Sep 1, 2021

Note, 3775bc8 was a force push of the result of manual rebase over the top of the now-landed PR#282.

@wolenetz
Copy link
Member Author

wolenetz commented Sep 1, 2021

@mwatson2: since @tidoust has approved this and it's been out for review for a month, I'll merge it shortly. If you prefer different, we can revert and fix later.

@wolenetz wolenetz merged commit 6efee8e into w3c:main Sep 1, 2021
github-actions bot added a commit that referenced this pull request Sep 1, 2021
SHA: 6efee8e
Reason: push, by @wolenetz

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@wolenetz wolenetz deleted the modernize_vars branch September 1, 2021 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants