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

Fix a double dash in the previewer if an @param jsdoc tag has a hyphen after the param name #53365

Merged
merged 4 commits into from
Jul 6, 2018

Conversation

coolreader18
Copy link
Contributor

@coolreader18 coolreader18 commented Jun 30, 2018

Here are some screenshots of the problem. The WIP tsdoc spec allows a hyphen after the param name, and I believe jsdoc does as well. This would cause a double dash if the description was a single line (— -), and a bullet point if it were multiple lines because of markdown.

Resolves #53507.

@roblourens
Copy link
Member

Is there an issue for this?

@coolreader18
Copy link
Contributor Author

coolreader18 commented Jun 30, 2018

#2387, maybe, but that's been closed.

@mjbvz
Copy link
Contributor

mjbvz commented Jul 2, 2018

@coolreader18 Please create a new issue to tie this PR to.

Also add a simple test case in https://github.com/Microsoft/vscode/blob/master/extensions/typescript-language-features/src/test/jsdocSnippet.test.ts

You can run this test using the TypeScript Extension Tests launch.json config in VS Code

@mjbvz
Copy link
Contributor

mjbvz commented Jul 6, 2018

Can you also please add a simple test case for this

@msftclas
Copy link

msftclas commented Jul 6, 2018

CLA assistant check
All CLA requirements met.

@mjbvz mjbvz added this to the July 2018 milestone Jul 6, 2018
@mjbvz mjbvz merged commit 8ab9119 into microsoft:master Jul 6, 2018
@mjbvz
Copy link
Contributor

mjbvz commented Jul 6, 2018

Thanks! This change will be in the next VS Code insiders build

@coolreader18 coolreader18 deleted the patch-1 branch July 6, 2018 21:51
@github-actions github-actions bot locked and limited conversation to collaborators Mar 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow a dash after @param in jsdoc comments?
4 participants