Skip to content
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

markdownDescriptions/markdownEnumDescriptions don't remove ## in settings.json hover #134592

Open
sean-mcmanus opened this issue Oct 7, 2021 · 4 comments
Assignees
Labels
bug Issue identified by VS Code Team member as probable bug confirmed Issue has been confirmed by VS Code Team member settings-editor VS Code settings editor issues
Milestone

Comments

@sean-mcmanus
Copy link
Contributor

Does this issue occur when all extensions are disabled?: Yes

  • VS Code Version: 1.60.0 and 1.61.0-insiders
  • OS Version: Windows

Steps to Reproduce:

  1. Open settings.json.
  2. Hover over some setting like files.autoSave.

Bug: It shows ## still for the command links:
image

It seems like the ## should be removed if settings.json can't handle it like the settings UI can.

Previously reported as #129844 , but it wasn't fixed (only the settings UI part was).

@sean-mcmanus sean-mcmanus changed the title markdownEnumDescriptions don't remove ## in settings.json hover markdownDescriptions/markdownEnumDescriptions don't remove ## in settings.json hover Oct 7, 2021
@roblourens
Copy link
Member

roblourens commented Oct 8, 2021

I thought there was a version of this open, but I guess it's just the issue you linked, thanks for finding that.

I don't really know what to do about this, I don't think we can actually implement the links in the same way, and the hover here is a generic thing pulling from the JSON schema.

One thing I've thought about is getting rid of the ## requirement, essentially if you have settingName in a description, we could linkify it without requiring special syntax.

@sean-mcmanus
Copy link
Contributor Author

I assume you mean the setting name would be between the markdown backticks as well (i.e. just the ## would removed). That would require extensions to remove the ## but our extension would be okay with that.

@roblourens roblourens assigned aeschli and rzhao271 and unassigned roblourens Oct 13, 2021
@rzhao271 rzhao271 added bug Issue identified by VS Code Team member as probable bug settings-editor VS Code settings editor issues labels Oct 13, 2021
@rzhao271 rzhao271 added this to the Backlog milestone Oct 13, 2021
@aeschli
Copy link
Contributor

aeschli commented Oct 15, 2021

As you say, the #settingName# notation is only understood by the settings UI. The JSON language server treats this as Markdown that it passes on to the hover.

An idea would be to use the Markdown link syntax similar to command links:. Something like [Editor: Detect Indentation](setting:settingName). It would look nice also in the hover and could bring you to the settings page.

@aeschli aeschli removed their assignment Oct 15, 2021
@rzhao271 rzhao271 added the confirmed Issue has been confirmed by VS Code Team member label Nov 15, 2021
@rzhao271 rzhao271 modified the milestones: Backlog, December 2021 Nov 29, 2021
@rzhao271 rzhao271 modified the milestones: January 2022, Backlog Jan 19, 2022
@gjsjohnmurray
Copy link
Contributor

Also happens with markdownDeprecationMessages, though presentation is slightly different, probably because problem hover isn't actually treating it as Markdown.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue identified by VS Code Team member as probable bug confirmed Issue has been confirmed by VS Code Team member settings-editor VS Code settings editor issues
Projects
None yet
Development

No branches or pull requests

5 participants