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

Improve generated comments #138

Closed
Shinigami92 opened this issue Oct 4, 2022 · 1 comment
Closed

Improve generated comments #138

Shinigami92 opened this issue Oct 4, 2022 · 1 comment
Labels
bug Something isn't working

Comments

@Shinigami92
Copy link
Collaborator

Currently some comments are not generated very well:

image

image

We should try to generate as few blank lines as needed or even don't generate empty JSDoc blocks.

Also we should add a test case for the functions that generates these comments.
@Shinigami92 Shinigami92 added the bug Something isn't working label Oct 4, 2022
@Julien-R44 Julien-R44 mentioned this issue Oct 5, 2022
Closed
@Dimava
Copy link
Contributor

Dimava commented Apr 22, 2023

I've requested no-blank-blocks rule on gajus/eslint-plugin-jsdoc#1042
So it may be possible to use eslint-plugin-jsdoc to cleanup unwanted minItems and empty /* */ comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Shinigami92 @Dimava