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

meta: Eslint JSDoc plugin #147

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

canerakdas
Copy link
Member

Description

I thought the Eslint JSDoc rules would make sense for comments that we might miss or were not properly formatted. I've updated the missing or incorrectly indented sections with this PR

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I've covered new added functionality with unit tests if necessary.

@canerakdas canerakdas requested a review from a team as a code owner November 16, 2024 21:01
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why the recommended config can't be used?

jsdoc.configs['flat/recommended-error']

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There seem to be stricter rules than the ones we apply, I can even say that I am against some of the rules being applied as recommended

I tried to combine the rules we already apply as much as possible when using/developing features or for a more efficient review process

Copy link
Member

@AugustinMauroy AugustinMauroy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants