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

Use the markdownDescription property for settings #4544

Closed
bobbrow opened this issue Nov 6, 2019 · 10 comments · Fixed by #8129
Closed

Use the markdownDescription property for settings #4544

bobbrow opened this issue Nov 6, 2019 · 10 comments · Fixed by #8129
Assignees
Labels
Feature Request fixed Check the Milestone for the release in which the fix is or will be available. Language Service quick fix

Comments

@bobbrow
Copy link
Member

bobbrow commented Nov 6, 2019

settings descriptions in package.json that reference enum values should use the markdownDescription property instead of description.

@Colengms
Copy link
Contributor

This is potentially problematic, as our settings descriptions get localized. We could see problems if the localization team does not use markdown in translations, or uses characters that inadvertently trigger markdown formatting.

@Colengms
Copy link
Contributor

I have this issue open against nls-dev, which doesn't appear to have gotten any attention. We could look at contributing this to nls-dev. microsoft/vscode-nls-dev#21

@sean-mcmanus sean-mcmanus modified the milestones: 0.27.0, 1.0 Feb 27, 2020
@bobbrow bobbrow modified the milestones: 1.0.0, On Deck Apr 13, 2020
@Colengms
Copy link
Contributor

Although the vscode-nls-dev issue I mentioned has been closed, it did not address the lack of a way to specify a 'hint' to localizers for strings defined in package.nls.json.

@Colengms
Copy link
Contributor

Colengms commented May 6, 2021

I created a PR to enable support for this, in vscode-nls-dev: microsoft/vscode-nls-dev#33

@sean-mcmanus sean-mcmanus modified the milestones: On Deck, 1.6.0 Jun 30, 2021
@sean-mcmanus sean-mcmanus self-assigned this Jun 30, 2021
@sean-mcmanus
Copy link
Contributor

sean-mcmanus commented Jun 30, 2021

We should also change all the settings reference to be like `#editor.tabSize#` so that they're linked.

@Colengms
Copy link
Contributor

Colengms commented Jul 7, 2021

Note that this is currently blocked until the next release of VS Code (>1.57.x), due to depending on this change: microsoft/vscode#126462

@sean-mcmanus
Copy link
Contributor

@Colengms 1.57.0 is already released....so it's not blocked?

@Colengms
Copy link
Contributor

Colengms commented Jul 8, 2021

1.57.0 was released on June 10. The fix was submitted on June 21. I assume that means we need to wait until 1.58 is released.

@sean-mcmanus
Copy link
Contributor

sean-mcmanus commented Jul 8, 2021

Okay, looks like they plan to release 1.58.0 any day now (microsoft/vscode#127394) ...but I'm not sure if that's too early to have a 1.58.0 pre-requisite for 1.6.0.

@sean-mcmanus sean-mcmanus assigned Colengms and unassigned sean-mcmanus Jul 9, 2021
@Colengms Colengms removed their assignment Jul 28, 2021
@sean-mcmanus sean-mcmanus self-assigned this Jul 29, 2021
@sean-mcmanus sean-mcmanus added quick fix fixed Check the Milestone for the release in which the fix is or will be available. labels Jul 30, 2021
@sean-mcmanus
Copy link
Contributor

Fixed in my clang-tidy branch...I might port it team/vcls/vscode later.

@sean-mcmanus sean-mcmanus modified the milestones: 1.6.0, 1.7.0 Aug 17, 2021
@sean-mcmanus sean-mcmanus modified the milestones: 1.7.0, 1.7.0-insiders Sep 16, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Oct 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Feature Request fixed Check the Milestone for the release in which the fix is or will be available. Language Service quick fix
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants