[typespec-vs] Fix missing doc on hover in vs #6012
+94
−56
Create fix-missing-doc-on-hover-in-vs-2025-1-14-2-56-0.md
- Loading branch information
commit 0833d0afd0e2699e8fbeeea004b051c9e9c0d4de
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| # Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking | ||
| changeKind: fix | ||
| packages: | ||
| - "@typespec/compiler" | ||
| --- | ||
|
|
||
| Fix missing documentation on hover in visual studio |
Oops, something went wrong.
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.
Can you add screenshot for VS in the description comparing the before and after, from the change I don't really understand how that would make it different.
This also makes it worse in VScode and if we have to choose between VSCode experience or Visual Studio, VSCode is way higher priority. This also make it probably worse with any other editor that we could integrate that respect the markdown field correctly.
Before
After (the inline code are not escaped and words are highlighted by some logic)
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.
Before
After
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.
It seems VS has a different way to parse the markdown doc. @mzhongl524 , please help to file a ticket to VS team to see whether it's a bug of them or they do have a different expectation of the passed markdown doc. It's better for us to guess here. thanks.
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.
Yeah this just feels like a bug with Visual studio, we are now cheating something to make Visual Studio work while VSCode and any other editor that actually respect the markdown(as the contract says) is now worse.