Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Mention benefit of providing
meta.docs.url
(#14774)
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
- Loading branch information