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

[Suggestion] Update comments in rules section of eslint-config-airbnb-base #3063

Open
lumirlumir opened this issue Nov 28, 2024 · 2 comments

Comments

@lumirlumir
Copy link

lumirlumir commented Nov 28, 2024

Hello,

Although the comments in the rules section are quite well-organized, some of them are outdated, incorrect, or missing official documentation links as ESLint has been updated.

Therefore, I would like to suggest updating the property comments in eslint-config-airbnb-base. If this suggestion is accepted, I can create a PR for it.

Here’s an example of the proposed change:

  • Before:
    // disallow use of Object.prototypes builtins directly
    // https://eslint.org/docs/rules/no-prototype-builtins
    'no-prototype-builtins': 'error',
  • After:
    /**
     * Disallow calling certain `Object.prototype` methods directly on objects.
     *
     * @link https://eslint.org/docs/latest/rules/no-prototype-builtins
     */
    'no-prototype-builtins': 'error',

If there are any other suggestions, I’d be happy to incorporate them.

@ljharb
Copy link
Collaborator

ljharb commented Nov 29, 2024

I’m happy to have links or other incorrect info corrected, but a jsdoc-style comment seems like a downgrade, not an upgrade, to me.

@lumirlumir
Copy link
Author

@ljharb Got it, I'll stick with the existing style!

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

No branches or pull requests

2 participants