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

Conform doc comments to TSDoc spec (experiment) #50736

Closed
wants to merge 2 commits into from

Conversation

jakebailey
Copy link
Member

This is just an experiment to see what it'd be like to conform to the TSDoc spec. The main change is the requirement of a dash after the parameter name, which the plugin complains about (however, their parser is lenient and doesn't need it; I wish the lint didn't complain, see microsoft/tsdoc#220).

Their ESLint plugin is thankfully not too slow to add:

tsdoc/syntax                                     |   267.625 |     1.8%

The generated TS lib files would also need to be updated, but we don't lint those as they come from the DOM generator.

@typescript-bot
Copy link
Collaborator

Thanks for the PR! It looks like you've changed the TSServer protocol in some way. Please ensure that any changes here don't break consumers of the current TSServer API. For some extra review, we'll ping @sheetalkamat, @amcasey, @mjbvz, @minestarks for you. Feel free to loop in other consumers/maintainers if necessary

@typescript-bot typescript-bot added Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug labels Sep 12, 2022
@jakebailey
Copy link
Member Author

Thanks bot for pinging everyone... 😠

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants