[GH-43213] Fix duplicate comments printed in quick info section #43240
Conversation
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
typescript-bot
added
the
For Uncommitted Bug
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
typescript-bot
added
For Backlog Bug
sandersn
requested changes
Mar 18, 2021
| @@ -584,7 +584,17 @@ namespace ts { | |||
| forEachUnique(declarations, declaration => { | |||
| const inheritedDocs = findBaseOfDeclaration(checker, declaration, symbol => symbol.getDocumentationComment(checker)); | |||
| // TODO: GH#16312 Return a ReadonlyArray, avoid copying inheritedDocs | |||
| if (inheritedDocs) doc = doc.length === 0 ? inheritedDocs.slice() : inheritedDocs.concat(lineBreakPart(), doc); | |||
There was a problem hiding this comment.
I don't think you need to write your own loop; findBaseOfDeclaration allows you to skip base declarations by returning undefined, so you can maintain seen: Set<Symbol> to allow you to skip a symbol that's been seen before.
There was a problem hiding this comment.
Also, the outer forEachUnique might be redundant with this fix in place. Might be worth running tests once with it removed to see.
|
@sandersn |
|
I removed the forEachUnique since it wasn't really doing much in this case and replaced it with a normal for each loop. |
sandersn
approved these changes
Mar 19, 2021
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.
Fixes #43213
Only push values to the comments array if it's unique (similar to how we do it for declartation comments in let doc = JsDoc.getJsDocCommentsFromDeclarations)