Skip to content

Editorial: Fix whitespace, punctuation, wording, markup#11387

Merged
domenic merged 24 commits into
whatwg:mainfrom
jmdyck:typos11
Jun 20, 2025
Merged

Editorial: Fix whitespace, punctuation, wording, markup#11387
domenic merged 24 commits into
whatwg:mainfrom
jmdyck:typos11

Conversation

@jmdyck

@jmdyck jmdyck commented Jun 19, 2025

Copy link
Copy Markdown
Contributor

@domenic domenic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM with some small suggested inline improvements on areas you're already improving. Notes:

  • This helps with, but doesn't fully fix, #8364.
  • feaaa17 is an improvement, but there are many cases of "Do thing, and let x be the result" which would be better as "Let x be the result of doing thing." (But, that seems best as a followup.)
  • 7c82bc2 is a big improvement; thank you

Comment thread source Outdated
<span>text track</span>'s <code data-x="">trak</code> box in the
first <code data-x="">moov</code> box
of the file be the <i>stsd box</i>, if any.
of the file, if any.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It would be better to do this as ", or null if no such stsd box exist".

Then the next line can be "If stsd box is null, or if...".

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done.

Comment thread source Outdated
<dt>If the <span>media resource</span> is an MPEG-4 file</dt>

<dd>Let the
<dd>Let the <var>stsd box</var> be the

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Here and below it'd be best to remove "the" before variable reference, since we're now treating stsd box as a real variable.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done.

(Grepping for the <var> in the source finds about 350. Is there a desire to get rid of all of them, or are there cases in which the preceding "the" is okay?)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think some cases seem to be OK, e.g. The <var>before</var> argument, the <var>index</var>th element, the <var>memory</var> map. Others seem incorrect, e.g. the <var>el</var> was created by the parser, If the <var>claimed type</var> is known, with, as its value, the <var>target URL</var>.

Comment thread source Outdated
data-x="fetching-scripts-perform-fetch">perform the fetch hook</span> given <var>request</var>,
<i data-x="fetching-scripts-is-top-level">isTopLevel</i> and <i
data-x="fetching-scripts-processCustomFetchResponse">processCustomFetchResponse</i>:</p>
<var data-x="fetching-scripts-is-top-level">isTopLevel</var> and <var

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
<var data-x="fetching-scripts-is-top-level">isTopLevel</var> and <var
<var data-x="fetching-scripts-is-top-level">isTopLevel</var>, and <var

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done, plus I found another.

@domenic
domenic merged commit d426109 into whatwg:main Jun 20, 2025
2 checks passed
@jmdyck
jmdyck deleted the typos11 branch June 21, 2025 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants