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

When both are defined, vscode should prefer markdownDescription over description #152859

Closed
a-stewart opened this issue Jun 22, 2022 · 1 comment · Fixed by #152860
Closed

When both are defined, vscode should prefer markdownDescription over description #152859

a-stewart opened this issue Jun 22, 2022 · 1 comment · Fixed by #152860
Assignees
@rzhao271 @sandy081
Labels
bug Issue identified by VS Code Team member as probable bug insiders-released Patch has been released in VS Code Insiders settings-editor VS Code settings editor issues verified Verification succeeded
Milestone
June 2022

Comments

@a-stewart
Copy link
Contributor

a-stewart commented Jun 22, 2022 •
edited
Loading

When defining an extensions configuration, there are two fields extensions can set, description and markdownDescription.

If an extension defines both, VS Code will prefer the plain text value, rather than the markdown one. Would it be better to change this default?

Due to #88927 some extensions were forced to define the description field, whilst this is now fixed, the hangover from it is that some extensions do still specify both.

In general I think it makes sense to use the markdown string where one is available instead of the plain text one?
@a-stewart a-stewart mentioned this issue Jun 22, 2022
Merged
@rzhao271 rzhao271 self-assigned this Jun 22, 2022
@rzhao271 rzhao271 added this to the June 2022 milestone Jun 22, 2022
@rzhao271 rzhao271 added the settings-editor VS Code settings editor issues label Jun 22, 2022
rzhao271 pushed a commit that referenced this issue Jun 22, 2022
@a-stewart
Prefer the markdown description in the preferences page (#152860)
a0067e5 
Fixes #152859

Co-authored-by: Anthony Stewart <anthonystewart@google.com>
@rzhao271 rzhao271 added the bug Issue identified by VS Code Team member as probable bug label Jun 22, 2022
@VSCodeTriageBot VSCodeTriageBot added unreleased Patch has not yet been released in VS Code Insiders insiders-released Patch has been released in VS Code Insiders and removed unreleased Patch has not yet been released in VS Code Insiders labels Jun 22, 2022
@rzhao271
Copy link
Contributor

Verification steps:

  1. Clone and run the following extension: https://github.com/rzhao271/vsc-152859
  2. Open the Settings editor and search vsc-152859.mySetting
  3. Verify that the description says "The markdown description. This description should show."

@aeschli aeschli added the verified Verification succeeded label Jun 30, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Aug 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@rzhao271 rzhao271

@sandy081 sandy081

Labels
bug Issue identified by VS Code Team member as probable bug insiders-released Patch has been released in VS Code Insiders settings-editor VS Code settings editor issues verified Verification succeeded
Projects
None yet
Milestone
June 2022
Development

Successfully merging a pull request may close this issue.

Prefer the markdown description in the preferences page a-stewart/vscode
5 participants
@a-stewart @aeschli @rzhao271 @sandy081 @VSCodeTriageBot