Commit bae0c09
authored
docs(linter): Add configuration option docs for jsdoc/require-yields rule. (#15024)
Part of #14743.
Generated docs:
```md
## Configuration
This rule accepts a configuration object with the following properties:
### exemptedBy
type: `string[]`
default: `["inheritdoc"]`
Functions with these tags will be exempted from the lint rule.
### forceRequireYields
type: `boolean`
default: `false`
When `true`, all generator functions must have a `@yields` tag, even if they don't yield a value or have an empty body.
### withGeneratorTag
type: `boolean`
default: `false`
When `true`, require `@yields` when a `@generator` tag is present.
```1 parent 06c77b6 commit bae0c09
1 file changed
+10
-5
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
77 | 78 | | |
78 | 79 | | |
79 | 80 | | |
80 | | - | |
| 81 | + | |
| 82 | + | |
81 | 83 | | |
82 | 84 | | |
83 | | - | |
| 85 | + | |
| 86 | + | |
84 | 87 | | |
85 | | - | |
| 88 | + | |
| 89 | + | |
86 | 90 | | |
87 | | - | |
| 91 | + | |
88 | 92 | | |
89 | | - | |
| 93 | + | |
90 | 94 | | |
91 | 95 | | |
| 96 | + | |
92 | 97 | | |
93 | 98 | | |
94 | 99 | | |
| |||
0 commit comments