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

markdownDescription is not respected in extensions' contributions tabs #88927

Closed
Gama11 opened this issue Jan 19, 2020 · 7 comments
Closed

markdownDescription is not respected in extensions' contributions tabs #88927

Gama11 opened this issue Jan 19, 2020 · 7 comments
Assignees
@sandy081
Labels
author-verification-requested Issues potentially verifiable by issue author bug Issue identified by VS Code Team member as probable bug extensions Issues concerning extensions insiders-released Patch has been released in VS Code Insiders verified Verification succeeded
Milestone
October 2021

Comments

@Gama11
Copy link
Contributor

Gama11 commented Jan 19, 2020 •
edited

  • VSCode Version: 1.41.1

VSCode extends the JSON schema for extension settings with a markdownDescription property which takes priority over a normal description. This seems to be why all the descriptions are missing on the "contributions" tab of the Haxe extension:

If I Ctrl+F-replace all the usages with a regular description, it looks good:

Note: if it's too much trouble, it's probably fine to just render markdown descriptions as plain text here, as long as they're rendered at all.

To reproduce:

"contributes": {
	"configuration": [
		{
			"title": "custom settings",
			"properties": {
				"test": {
					"markdownDescription": "Hello `World`",
					"type": "boolean",
					"default": false
				}
			}
		}
	]
}
@sandy081 sandy081 added extensions Issues concerning extensions feature-request Request for new features or functionality labels Jan 21, 2020
@sandy081 sandy081 added this to the Backlog Candidates milestone Jan 21, 2020
@vscodebot
Copy link

vscodebot bot commented Jan 21, 2020

This feature request is now a candidate for our backlog. The community has 60 days to upvote the issue. If it receives 20 upvotes we will move it to our backlog. If not, we will close it. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

@Gama11
Copy link
Contributor Author

Gama11 commented Jan 21, 2020

If it receives 20 upvotes we will move it to our backlog.

Might as well just close it right away then...

@Gama11
Copy link
Contributor Author

Gama11 commented Jan 22, 2020

Why is this considered a feature request btw, rather than a bug?

@sandy081
Copy link
Member

Because this is something which was not there before and adding it is a feature

@Gama11
Copy link
Contributor Author

Gama11 commented Jan 23, 2020 •
edited

Well... if the point of markdownDescription is to be an alternative to description, any place where it's ignored would be an oversight / bug in my opinion. I don't even really care that much about this, I only reported it because I thought it's an obvious oversight and you'd be interested in making the behavior consistent.

Anyway, this isn't the sort of thing to get upvoted (let alone 20 times), so I'll just close.

@Gama11 Gama11 closed this as completed Jan 23, 2020
@vscodebot vscodebot bot locked and limited conversation to collaborators Mar 8, 2020
@sandy081 sandy081 reopened this Sep 28, 2021
@sandy081 sandy081 modified the milestones: Backlog Candidates, Backlog Sep 28, 2021
@sandy081 sandy081 modified the milestones: Backlog, October 2021 Oct 22, 2021
@sandy081 sandy081 added bug Issue identified by VS Code Team member as probable bug and removed feature-request Request for new features or functionality labels Oct 25, 2021
@sandy081
Copy link
Member

We were supporting rendering markdown description but it was broken. So fixed it.

@mjbvz mjbvz added the author-verification-requested Issues potentially verifiable by issue author label Oct 27, 2021
@alexr00 alexr00 added the verified Verification succeeded label Oct 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@sandy081 sandy081

Labels
author-verification-requested Issues potentially verifiable by issue author bug Issue identified by VS Code Team member as probable bug extensions Issues concerning extensions insiders-released Patch has been released in VS Code Insiders verified Verification succeeded
Projects
None yet
Milestone
October 2021
Development

No branches or pull requests
5 participants
@Gama11 @sandy081 @mjbvz @alexr00 and others