-
Notifications
You must be signed in to change notification settings - Fork 245
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
[typespec-vs] Fix missing doc on hover in vs #6012
Closed
mzhongl524
wants to merge
21
commits into
microsoft:main
from
mzhongl524:fix-missing-doc-on-hover-in-vs
Closed
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
b0ac596
Merge pull request #1 from microsoft/main
mzhongl524 3fcbe52
Merge branch 'microsoft:main' into main
mzhongl524 c109816
Merge branch 'microsoft:main' into main
mzhongl524 23f0108
Merge branch 'microsoft:main' into main
mzhongl524 6f04f65
Merge branch 'microsoft:main' into main
mzhongl524 688ca03
Merge branch 'microsoft:main' into main
mzhongl524 de3725e
Merge branch 'microsoft:main' into main
mzhongl524 8130ffb
Merge branch 'microsoft:main' into main
mzhongl524 beb6433
Merge branch 'microsoft:main' into main
mzhongl524 8a501f2
Merge branch 'microsoft:main' into main
mzhongl524 6e1ab2d
Merge branch 'microsoft:main' into main
mzhongl524 a35052f
Merge branch 'microsoft:main' into main
mzhongl524 be57c13
Merge branch 'microsoft:main' into main
mzhongl524 3a9dc7a
Merge branch 'microsoft:main' into main
mzhongl524 ad7dff7
Merge branch 'microsoft:main' into main
mzhongl524 f8e8f2f
Merge branch 'microsoft:main' into main
mzhongl524 619ccbb
Make the hover prompts in vs and vscode consistent
mzhongl524 4200f2c
adjust the test
mzhongl524 0833d0a
Create fix-missing-doc-on-hover-in-vs-2025-1-14-2-56-0.md
mzhongl524 dd496fe
adjust the test
mzhongl524 38656bb
Merge branch 'fix-missing-doc-on-hover-in-vs' of https://github.com/m…
mzhongl524 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
8 changes: 8 additions & 0 deletions
8
.chronus/changes/fix-missing-doc-on-hover-in-vs-2025-1-14-2-56-0.md
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 |
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
Oops, something went wrong.
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.