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

Editorial: fix linking and change spelling of iterator interfaces #3459

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

michaelficarra
Copy link
Member

@michaelficarra michaelficarra commented Oct 22, 2024

Fixes #3455. This adds a bunch of <dfn>s and the auto-linking is sooo much better. Also makes a lot of progress getting rid of the remaining <i>s that are used as pseudo-<dfn>s.

edit: Actually, this eliminates all of the remaining <i>s! Nice!

spec.html Outdated Show resolved Hide resolved
@@ -4041,7 +4041,7 @@ <h1>Well-Known Intrinsic Objects</h1>
<td>
</td>
<td>
The prototype of wrapped Iterator objects returned by Iterator.from (<emu-xref href="#sec-%wrapforvaliditeratorprototype%-object"></emu-xref>)
The prototype of wrapped iterator objects returned by Iterator.from (<emu-xref href="#sec-%wrapforvaliditeratorprototype%-object"></emu-xref>)
Copy link
Contributor

Choose a reason for hiding this comment

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

This use could remain capitalized as well, since the returned values do in fact inherit from Iterator.

Copy link
Member Author

Choose a reason for hiding this comment

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

Elsewhere we use "Iterator instance objects" to refer to iterators in a way that also requires that they inherit from Iterator.

spec.html Outdated Show resolved Hide resolved
@bakkot
Copy link
Contributor

bakkot commented Oct 22, 2024

This also fixes #3426

Copy link
Member

@linusg linusg left a comment

Choose a reason for hiding this comment

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

Nice, thanks!

jmdyck
jmdyck previously requested changes Oct 22, 2024
Copy link
Collaborator

@jmdyck jmdyck left a comment

Choose a reason for hiding this comment

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

There are two remaining (non-<h1>) occurrences of "Iterator Objects" that you presumably want to change to "Iterator objects":

  • has properties that are inherited by all For-In Iterator Objects.
  • has properties that are inherited by all Async-from-Sync Iterator Objects.

@michaelficarra michaelficarra added ready to merge Editors believe this PR needs no further reviews, and is ready to land. and removed editor call to be discussed in the next editor call labels Oct 30, 2024
@ljharb ljharb merged commit d0e5feb into main Oct 31, 2024
9 checks passed
@ljharb ljharb deleted the GH-3455 branch October 31, 2024 05:54
jmdyck added a commit to jmdyck/ecma262 that referenced this pull request Nov 7, 2024
It looks like PR tc39#3459 missed these changes
to capitalization and use of "<em>".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial change ready to merge Editors believe this PR needs no further reviews, and is ready to land.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Uppercase "Iterator" falsely autolinks to constructor <dfn> IteratorResult object
6 participants