You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 #7505Add returns after JSDoc comments for consistency.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: