Skip to content

Commit 82be5a6

Browse files
committed
docs: make explicit default for setting ignorePrivate and clarify setting
1 parent 92bf5b2 commit 82be5a6

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
@@ -121,7 +121,7 @@ You can then selectively add to or override the recommended rules.
121121
### Allow `@private` to disable rules for that comment block
122122

123123
- `settings.jsdoc.ignorePrivate` - Disables all rules for the comment block
124-
on which it occurs.
124+
on which a `@private` tag occurs. Defaults to `false`.
125125

126126
### Alias Preference
127127

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ You can then selectively add to or override the recommended rules.
164164
### Allow <code>@private</code> to disable rules for that comment block
165165

166166
- `settings.jsdoc.ignorePrivate` - Disables all rules for the comment block
167-
on which it occurs.
167+
on which a `@private` tag occurs. Defaults to `false`.
168168

169169
<a name="eslint-plugin-jsdoc-settings-alias-preference"></a>
170170
### Alias Preference

0 commit comments

Comments
 (0)