Editorial: String.prototype.matchAll iterators won't return null #3423
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
spec.html
Outdated
| @@ -34894,7 +34894,7 @@ <h1>String.prototype.match ( _regexp_ )</h1> | |||
|
|
|||
| <emu-clause id="sec-string.prototype.matchall"> | |||
| <h1>String.prototype.matchAll ( _regexp_ )</h1> | |||
| <p>This method performs a regular expression match of the String representing the *this* value against _regexp_ and returns an iterator. Each iteration result's value is an Array containing the results of the match, or *null* if the String did not match.</p> | |||
| <p>This method performs a regular expression match of the String representing the *this* value against _regexp_ and returns an iterator. Each iteration result's value is an Array containing the results of the match.</p> | |||
There was a problem hiding this comment.
This is fine, but I would probably say a bit more.
Suggested change
| <p>This method performs a regular expression match of the String representing the *this* value against _regexp_ and returns an iterator. Each iteration result's value is an Array containing the results of the match.</p> | |
| <p>This method performs a regular expression match of the String representing the *this* value against _regexp_ and returns an iterator that yields match results. Each match result is an Array containing the matched portion of the String as the first element, followed by the portions matched by any capturing groups. If the regular expression never matches, the returned iterator does not yield any match results.</p> |
There was a problem hiding this comment.
We could also <dfn> a term for these match result arrays constructed and returned by RegExpBuiltinExec. /cc @tc39/ecma262-editors
There was a problem hiding this comment.
In the editor call today, @syg agreed that we should probably <dfn> this thing. We could do it as part of this PR or as a follow-up, doesn't matter to me.
There was a problem hiding this comment.
Thank you for the review!
I'm totally not sure how to add a definition for the term, so I'd prefer not to address that in this PR.
michaelficarra
added
editor call
michaelficarra
approved these changes
Sep 21, 2024
bakkot
approved these changes
Oct 2, 2024
syg
approved these changes
Oct 2, 2024
michaelficarra
added
the
ready to merge
michaelficarra
force-pushed
the
tweak-string-prototype-matchall-description
branch
from
ea3f999
to
b688e11
Compare
ljharb
force-pushed
the
tweak-string-prototype-matchall-description
branch
from
b688e11
to
76814cb
Compare
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
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.
Closes #3421