Give the JSDocTagInfo type a consistent text type
#44551
Closed
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
typescript-bot
added
Author: Team
For Uncommitted Bug
orta
force-pushed
the
string_or_display_part
branch
from
b04ec37 to
b30436f
Compare
|
In what circumstances is text still a string? I thought that it was now always turned into a SymbolDisplayPart. As far as I can see the only place these are created is in services/jsDoc.ts, which calls getCommentDisplayParts to produce them. That function wraps string-only comments in Looks like the server still produces strings if richResponse is false (the default), though. |
|
I think Monaco had fixes for this instead. |
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.
I think the reason why we ended up with
[object object]in the Playground for JSDoc results occasionally is due to me first spottingJSDocTagInfowithtext?: stringand ignoring the later version oftext?: string | SymbolDisplayPart( see microsoft/monaco-typescript#81 )This should make them consistent, if that makes sense I'll get this PR green 👍🏻