Skip to content

Commit 9b5dfa4

Browse files
committed
docs: Use correct setting name allowPrivate->ignorePrivate
1 parent 22763a1 commit 9b5dfa4

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

.README/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Finally, enable all of the rules that you would like to use.
109109

110110
### Allow `@private` to disable rules for that comment block
111111

112-
- `settings.jsdoc.allowPrivate` - Disables all rules for the comment block
112+
- `settings.jsdoc.ignorePrivate` - Disables all rules for the comment block
113113
on which it occurs.
114114

115115
### Exempting empty functions from `require-jsdoc`

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Finally, enable all of the rules that you would like to use.
157157
<a name="eslint-plugin-jsdoc-settings-allow-private-to-disable-rules-for-that-comment-block"></a>
158158
### Allow <code>@private</code> to disable rules for that comment block
159159

160-
- `settings.jsdoc.allowPrivate` - Disables all rules for the comment block
160+
- `settings.jsdoc.ignorePrivate` - Disables all rules for the comment block
161161
on which it occurs.
162162

163163
<a name="eslint-plugin-jsdoc-settings-exempting-empty-functions-from-require-jsdoc"></a>

0 commit comments

Comments
 (0)