-
Notifications
You must be signed in to change notification settings - Fork 12.9k
Remove duplicate JSDoc comments #38489
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
1450908
Added tests for union types with identical doc comments.
DanielRosenwasser 74d6d04
Don't add duplicates of JSDoc comments.
DanielRosenwasser e9867a7
Add and use the 'intersperse' helper function.
DanielRosenwasser 355c28e
Update baselines.
DanielRosenwasser File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
60 changes: 60 additions & 0 deletions
60
tests/baselines/reference/quickInfoOnUnionPropertiesWithIdenticalJSDocComments01.baseline
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
[ | ||
{ | ||
"marker": { | ||
"fileName": "/tests/cases/fourslash/quickInfoOnUnionPropertiesWithIdenticalJSDocComments01.ts", | ||
"position": 746 | ||
}, | ||
"quickInfo": { | ||
"kind": "property", | ||
"kindModifiers": "optional", | ||
"textSpan": { | ||
"start": 746, | ||
"length": 8 | ||
}, | ||
"displayParts": [ | ||
{ | ||
"text": "(", | ||
"kind": "punctuation" | ||
}, | ||
{ | ||
"text": "property", | ||
"kind": "text" | ||
}, | ||
{ | ||
"text": ")", | ||
"kind": "punctuation" | ||
}, | ||
{ | ||
"text": " ", | ||
"kind": "space" | ||
}, | ||
{ | ||
"text": "language", | ||
"kind": "propertyName" | ||
}, | ||
{ | ||
"text": "?", | ||
"kind": "punctuation" | ||
}, | ||
{ | ||
"text": ":", | ||
"kind": "punctuation" | ||
}, | ||
{ | ||
"text": " ", | ||
"kind": "space" | ||
}, | ||
{ | ||
"text": "string", | ||
"kind": "keyword" | ||
} | ||
], | ||
"documentation": [ | ||
{ | ||
"text": "A language id, like `typescript`.", | ||
"kind": "text" | ||
} | ||
] | ||
} | ||
} | ||
] |
29 changes: 29 additions & 0 deletions
29
tests/cases/fourslash/quickInfoOnUnionPropertiesWithIdenticalJSDocComments01.ts
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
/// <reference path="fourslash.ts" /> | ||
|
||
////export type DocumentFilter = { | ||
//// /** A language id, like `typescript`. */ | ||
//// language: string; | ||
//// /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */ | ||
//// scheme?: string; | ||
//// /** A glob pattern, like `*.{ts,js}`. */ | ||
//// pattern?: string; | ||
////} | { | ||
//// /** A language id, like `typescript`. */ | ||
//// language?: string; | ||
//// /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */ | ||
//// scheme: string; | ||
//// /** A glob pattern, like `*.{ts,js}`. */ | ||
//// pattern?: string; | ||
////} | { | ||
//// /** A language id, like `typescript`. */ | ||
//// language?: string; | ||
//// /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */ | ||
//// scheme?: string; | ||
//// /** A glob pattern, like `*.{ts,js}`. */ | ||
//// pattern: string; | ||
////}; | ||
//// | ||
////declare let x: DocumentFilter; | ||
////x./**/language | ||
|
||
verify.baselineQuickInfo(); |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment on 86 claims it's already deduping? Is the
forEachUnique
meant to do this? Why didn't that workUh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So I thought the same thing (i.e. "whoever wrote this must be mistaken!") but reading that comment, I understand
forEachUnique
must dedupe across declarations, and something likehas the same declarations between
Array<string>
andArray<number>
for either of them.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could technically let the identical string checks handle this instead.