Editorial: use newer method/getter/setter styles #7294
Merged
Conversation
This file contains 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
For many (but not all) method/getter/setter definitions, update to use: * The defined term "this", instead of "this X object" or "the X object" * The "method steps"/"getter steps"/"setter steps" introductory clauses * Separate method steps for overloads, calling into a shared algorithm
domenic
added
the
editorial
annevk
approved these changes
Nov 4, 2021
| data-x="concept-get-all-indexed">getting the "all"-indexed element</span> from this | ||
| <code>HTMLAllCollection</code> given the number represented by <var>nameOrIndex</var>.</p></li> | ||
| data-x="concept-get-all-indexed">getting the "all"-indexed element</span> from | ||
| <var>collection</var> given the number represented by <var>nameOrIndex</var>.</p></li> |
There was a problem hiding this comment.
Nice copypasta find here and below!
|
Hooray! Thanks especially for pushing fixups instead of asking for me to do them, so that we could merge this quickly :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
For many (but not all) method/getter/setter definitions, update to use:
I had the ambition of removing all "this X object" uses, but some are more complicated and I gave up about 2/3 of the way through, realizing I'd spent too much time on this already. Still, a nice step in the right direction. Searching for
this[\s\n]+<code>[^<]+</code>(?![\s\n]+element)now gives 64 matches, mostly OffscreenCanvas, CustomElementRegistry, and ElementInternals.Most changes here are mechanical but the canvas methods I updated probably need a bit closer review than the rest.
/browsers.html ( diff )
/canvas.html ( diff )
/common-dom-interfaces.html ( diff )
/dynamic-markup-insertion.html ( diff )
/form-elements.html ( diff )
/history.html ( diff )
/imagebitmap-and-animations.html ( diff )
/links.html ( diff )
/media.html ( diff )
/web-messaging.html ( diff )
/window-object.html ( diff )
/workers.html ( diff )