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

Standardize line feed between description and tags in JSDoc #7510

Open
leonden opened this issue Feb 17, 2024 · 0 comments
Open

Standardize line feed between description and tags in JSDoc #7510

leonden opened this issue Feb 17, 2024 · 0 comments
Labels
type:maintenance tests, chores, or project maintenance

Comments

@leonden
Copy link

leonden commented Feb 17, 2024

Is your feature request related to a problem? Please describe.
There is no standardized way for JSDoc comments. As a best practice, I consider a line feed in between a JSDoc description and (if existing) tag as appropriate to make all JSDo comments more consistent.

Describe the solution you'd like
As of my knowledge, a new rule inside of the .eslintrc.cjs in the root directory could do the job and prevent developers from not adding a line feed in between.

Describe alternatives you've considered
As a possible alternative I could consider adding this into the contributors guide, even though this approach is not as handy as updating the linting config.

Additional context
This issue emerged out of PR #7505 Add returns after JSDoc comments for consistency.

@unlikelyzero unlikelyzero added type:maintenance tests, chores, or project maintenance and removed type:enhancement labels Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:maintenance tests, chores, or project maintenance
Projects
None yet
Development

No branches or pull requests

2 participants