Skip to content

Commit 6fab4c2

Browse files
authored
Docs: clarify some wording in require-meta-docs-url rule doc (#126)
1 parent 2fe92b7 commit 6fab4c2

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

docs/rules/require-meta-docs-url.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# require rules to implement a meta.docs.url property (require-meta-docs-url)
22

3-
`meta.docs.url` property is the official location to store a URL to their documentation in the rule metadata.
4-
Some integration tools will show the URL to users to understand rules.
3+
A rule can store the URL to its documentation page in `meta.docs.url`. This enables integration tools / IDEs / editors to conveniently provide the link to developers so that they can better understand the rule.
54

65
## Rule Details
76

@@ -17,7 +16,7 @@ This rule has an option.
1716
}
1817
```
1918

20-
- `pattern` (`string`) ... A pattern to enforce rule's document URL. It replaces `{{name}}` placeholder by each rule name. The rule name is the basename of each rule file. Default is undefined.
19+
- `pattern` (`string`) ... A pattern to enforce rule's document URL. It replaces `{{name}}` placeholder by each rule name. The rule name is the basename of each rule file. Default is `undefined` which allows any URL.
2120

2221
If you set the `pattern` option, this rule adds `meta.docs.url` property automatically when you execute `eslint --fix` command.
2322

0 commit comments

Comments
 (0)