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.

Sign up for GitHub

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

Jump to bottom

Respect markdownDescription vs description in settings editor #55478

Closed
mjbvz opened this issue Jul 31, 2018 · 3 comments
Closed

Respect markdownDescription vs description in settings editor #55478

mjbvz opened this issue Jul 31, 2018 · 3 comments
Assignees
@roblourens
Labels
bug Issue identified by VS Code Team member as probable bug release-notes Release notes issues settings-editor VS Code settings editor issues verified Verification succeeded
Milestone
August 2018

Comments

@mjbvz
Copy link
Collaborator

mjbvz commented Jul 31, 2018 •
edited
Loading

  • VSCode Version:
  • OS Version:

Steps to Reproduce:

  1. Open the old settings editor
  2. Hover over a settings such as "window.title" on the right hand side

Bug
Markdown is not rendered in the hover

screen shot 2018-07-31 at 5 02 56 pm

Does this issue occur when all extensions are disabled?: Yes
@roblourens
Copy link
Member

roblourens commented Jul 31, 2018 •
edited
Loading

How do I make it do that like it does for other hovers? @jrieken?

@roblourens roblourens added bug Issue identified by VS Code Team member as probable bug settings-editor VS Code settings editor issues labels Jul 31, 2018
@roblourens roblourens added this to the July 2018 milestone Jul 31, 2018
@mjbvz
Copy link
Collaborator Author

mjbvz commented Jul 31, 2018

Looks like those hovers come from our json support? You can render the hover content as markdown by returning it as a MarkdownString

@roblourens
Copy link
Member

We have to change all the setting registrations to use markdownDescription and markdownEnumDescriptions...

@roblourens roblourens changed the title Setting hovers in settings.json do not render markdown content Respect markdownDescription vs description in settings editor Aug 3, 2018
@roblourens roblourens mentioned this issue Aug 3, 2018
Closed
38 tasks
@roblourens roblourens added the release-notes Release notes issues label Aug 9, 2018
roblourens added a commit that referenced this issue Aug 9, 2018
@roblourens
#55478 - render description vs markdownDescription correctly
48f3326
roblourens added a commit that referenced this issue Aug 9, 2018
@roblourens
#55478 - switch all builtin settings to 'markdownDescription' instead…
a076421 
… of 'description' where needed
@sandy081 sandy081 added the verified Verification succeeded label Aug 29, 2018
@vscodebot vscodebot bot locked and limited conversation to collaborators Sep 23, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@roblourens roblourens

Labels
bug Issue identified by VS Code Team member as probable bug release-notes Release notes issues settings-editor VS Code settings editor issues verified Verification succeeded
Projects
None yet
Milestone
August 2018
Development

No branches or pull requests
3 participants
@roblourens @sandy081 @mjbvz