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

[Bug] JSON Schema: markdownDescription rendered by hover but not in the suggestion details #4209

Closed
1 of 2 tasks
kokovtsev opened this issue Oct 7, 2023 · 4 comments · Fixed by #4210
Closed
1 of 2 tasks
Labels
bug Issue identified by VS Code Team member as probable bug languages-basic verified Verification succeeded

Comments

@kokovtsev
Copy link
Contributor

kokovtsev commented Oct 7, 2023

Reproducible in vscode.dev or in VS Code Desktop?

  • Not reproducible in vscode.dev or VS Code Desktop

Reproducible in the monaco editor playground?

Monaco Editor Playground Link

https://microsoft.github.io/monaco-editor/playground.html?source=v0.44.0#XQAAAAKQAwAAAAAAAABBqQkHQ5NjdMjwa-jY7SIQ9S7DNlzs5W-mwj0fe1ZCDRFc9ws9XQE0SJE1jc2VKxhaLFIw9vEWSxW3yscw4b6edHDvqPO_68xRV--3NT2MM2834uyP1NFQSuE5MZ_Nq3KbJ8knXgkBtVcJlXvFpqi52nEJOlHHOW4TnpixJdt1LWadSDDzk_yi19xmFJNMskikeS2E_YG9wvp5Jt4Lpt9c9ATGWrgOSRS2rgR9K_qvQYsnk-OsXhTdW-pFYg0t-byPbeao-mnu48nwbQmq1mh5PlY4U_a9xMUkEC649ZOQIqyzc9mEBiJH7vsT8lWL453MoHyfvKzmkrsP27yaMdeHWFco2JBjA9oD74oKe4P6gvgcKQF9q5LDR-vfDmA1dOIhj-bUXpGCBZ_8-DMfW92oLbZdKYMKu2Hi6Yux8bcmpkOWgrj91T8oKHh4-DnGfYIL0ZjKQL9FD1WFCEAPq4YXsOXuJiyhRqjocuf2g93DHCKtbmFJsUOVnYTi8m-tUgWVOtUxJRL4zvoQEvy8cx0EhlLrO9O0YQbMAJKe8dvojeAgyT9lucMzDVPdNd45npt6Mc_NgHa0iRCWrKZ1j5UMVN3dX3mp7C-7uYnOhEVmZm95lFAnCMGOdQb121UrOaSvbxLJ9zSsFGZL8BXRHl5pu9aLkVOwg5IF4hZrN2qCiT79mdde

Monaco Editor Playground Code

monaco.languages.json.jsonDefaults.setDiagnosticsOptions({
	validate: true,
	schemas: [
		{
			uri: "http://myserver/foo-schema.json", // id of the first schema
			"fileMatch": [
				"*"
			],
			"schema": {
				"type": "object",
				"properties": {
					"hello": {
						"markdownDescription": "This is **markdown**",
						"type": "string"
					}
				}
			}
		}
	],
});

Reproduction Steps

Case 1: hover the hello property in the editor
Case 2: put the cursor inside the hello key, press Ctrl-Space to trigger the suggestion box and Ctrl-Space once again to show the details

Actual (Problematic) Behavior

Case 1: the markdown documentation is displayed correctly
Case 2: suggestion details do not appear at all

Expected Behavior

In both cases, the same properly formatted description should be shown

Additional Context

Please note that if I provide both description and markdownDescription, the former is displayed in suggestion details and the latter - on hover

Thanks for your great work!

@Time1sMoney
Copy link

Has this problem been solved? I want to know how to display the description in the schema completion.

@kokovtsev
Copy link
Contributor Author

Apparently it's not...

@hediet sorry for reaching out to you directly but it seems that you've been active in this repo, and I am not the only one interested in this fix. Could you please help us getting the linked PR reviewed and solved?

@hediet hediet added this to the December / January 2024 milestone Dec 14, 2023
@hediet hediet added bug Issue identified by VS Code Team member as probable bug languages-basic labels Dec 14, 2023
@TylerLeonhardt TylerLeonhardt added the verification-steps-needed Steps to verify are needed for verification label Jan 24, 2024
@TylerLeonhardt
Copy link
Member

@hediet can you give us some steps on how to verify?

@TylerLeonhardt
Copy link
Member

I think I figured it out. Looks verified:
image

@TylerLeonhardt TylerLeonhardt added verified Verification succeeded and removed verification-steps-needed Steps to verify are needed for verification labels Jan 24, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jan 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Issue identified by VS Code Team member as probable bug languages-basic verified Verification succeeded
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants