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

Docs: Mention benefit of rules providing meta.docs.url #14774

Merged
merged 1 commit into from Jul 8, 2021
Merged

Docs: Mention benefit of rules providing meta.docs.url #14774

merged 1 commit into from Jul 8, 2021

Commits on Jul 6, 2021

  1. Docs: Mention benefit of providing meta.docs.url 

    Perhaps the top benefit of rules providing the `meta.docs.url` property with a link to their documentation is that IDEs / code editors can then provide a helpful link on rule violations. Developers often find this link useful to better understand a violation and learn how to fix it.

However, many rule authors are unaware of this feature and thus exclude the property because they don't see the value of it.

Mentioning this feature in ESLint's rule documentation should help encourage greater adoption of this property.

Note that there is also a lint rule to require and autofix this property: https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-docs-url.md
    @bmish
    bmish committed Jul 6, 2021
    Copy the full SHA
    eeb19ab View commit details
    Browse the repository at this point in the history