Skip to content

Fix(47969): String.prototypr.replace docs fix #50041

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.

Sign up for GitHub

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

Merged
merged 10 commits into from
Sep 28, 2022
Merged

Fix(47969): String.prototypr.replace docs fix #50041

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3cade4c
String.prototype.replace docs fix.
navya9singh Jul 25, 2022
04df1e1
Follow up changes to es5.d.ts
navya9singh Jul 25, 2022
34c3b9c
Fixed changes to previous commit:
navya9singh Jul 25, 2022
472584f
Changes to resolve pr comments
navya9singh Jul 27, 2022
29e50b3
Rewording documentation
navya9singh Sep 16, 2022
0507192
Accepting baselines
navya9singh Sep 16, 2022
906510e
Fixes for pr
navya9singh Sep 16, 2022
305f4bd
Merge branch 'main' into fix/47969
navya9singh Sep 20, 2022
abc58bd
Fixing baseline errors
navya9singh Sep 20, 2022
8e71f42
Fixing pr comments
navya9singh Sep 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/lib/es2015.symbol.wellknown.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,9 +219,9 @@ interface String {
match(matcher: { [Symbol.match](string: string): RegExpMatchArray | null; }): RegExpMatchArray | null;

/**
* Replaces first match with string or all matches with RegExp.
* @param searchValue A string or RegExp search value.
* @param replaceValue A string containing the text to replace for match.
* Passes a string and {@linkcode replaceValue} to the [Symbol.replace] method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm.
Copy link
Contributor

@Josh-Cena Josh-Cena Jul 28, 2022

Choose a reason for hiding this comment

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

Suggested change
* Passes a string and {@linkcode replaceValue} to the [Symbol.replace] method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm.
* Passes a string and {@linkcode replaceValue} to the `[Symbol.replace]` method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm.

(Suggestion, dunno if the stdlib has its own style rules about JSDoc. Also @@replace is technically the name for the method—it's only accessed via Symbol.replace)

Copy link
Member

@sandersn sandersn Jul 29, 2022

Choose a reason for hiding this comment

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

I like the formatting improvement, but I think @@replace is only useful for people who have read the spec.

Copy link
Contributor

@Josh-Cena Josh-Cena Jul 29, 2022

Choose a reason for hiding this comment

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

Yeah, I'm fine with [Symbol.replace]. FWIW, on MDN we consistently use RegExp.prototype[@@replace]() so I hope it's not that obscure, but I can understand.

* @param searchValue An object that supports searching for and replacing matches within a string.
* @param replaceValue The replacement text.
*/
replace(searchValue: { [Symbol.replace](string: string, replaceValue: string): string; }, replaceValue: string): string;

Expand Down
4 changes: 2 additions & 2 deletions src/lib/es5.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,8 +429,8 @@ interface String {

/**
* Replaces text in a string, using a regular expression or search string.
* @param searchValue A string to search for.
* @param replaceValue A string containing the text to replace for every successful match of searchValue in this string.
* @param searchValue A string or regular expression to search for.
* @param replaceValue A string containing the text to replace. When the {@linkcode searchValue} is a string, only the first match is replaced. If the {@linkcode searchValue} is a RegExp, all matches are replaced if the g flag is set. Otherwise only the first one is.
Copy link
Member

@sandersn sandersn Sep 12, 2022

Choose a reason for hiding this comment

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

I think I would reword this to highlight the interesting global regex case first, and try to cover strings and sticky regexes later.

Suggested change
* @param replaceValue A string containing the text to replace. When the {@linkcode searchValue} is a string, only the first match is replaced. If the {@linkcode searchValue} is a RegExp, all matches are replaced if the g flag is set. Otherwise only the first one is.
* @param replaceValue A string containing the text to replace. When the {@linkcode searchValue} is a RegExp, all matches are replaced if the g flag is set (taking into account the y flag if present). Otherwise {@linkcode searchValue} only the first match is replaced.

*/
replace(searchValue: string | RegExp, replaceValue: string): string;

Expand Down
50 changes: 48 additions & 2 deletions tests/baselines/reference/completionsStringMethods.baseline
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1048,7 +1048,7 @@
"kind": "space"
},
{
"text": "A string to search for.",
"text": "A string or regular expression to search for.",
"kind": "text"
}
]
Expand All @@ -1065,7 +1065,53 @@
"kind": "space"
},
{
"text": "A string containing the text to replace for every successful match of searchValue in this string.",
"text": "A string containing the text to replace. When the ",
"kind": "text"
},
{
"text": "{@linkcode ",
"kind": "link"
},
{
"text": "searchValue",
"kind": "linkName",
"target": {
"fileName": "lib.d.ts",
"textSpan": {
"start": 19079,
"length": 28
}
}
},
{
"text": "}",
"kind": "link"
},
{
"text": " is a string, only the first match is replaced. If the ",
"kind": "text"
},
{
"text": "{@linkcode ",
"kind": "link"
},
{
"text": "searchValue",
"kind": "linkName",
"target": {
"fileName": "lib.d.ts",
"textSpan": {
"start": 19079,
"length": 28
}
}
},
{
"text": "}",
"kind": "link"
},
{
"text": " is a RegExp, all matches are replaced if the g flag is set. Otherwise only the first one is.",
"kind": "text"
}
]
Expand Down