Skip to content

Commit 547a1c9

Browse files
committed
docs: clarify comment on options structure
1 parent 08e76b1 commit 547a1c9

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.README/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ object supplied as the second argument in an array after the error level
115115
'jsdoc/require-example': [
116116
// The Error level should be `error`, `warn`, or `off` (or 2, 1, or 0)
117117
'error',
118-
// The options vary by rule, but are added to an options object:
118+
// The options vary by rule, but are generally added to an options
119+
// object as follows:
119120
{
120121
avoidExampleOnConstructors: true,
121122
exemptedBy: ['type']

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,8 @@ object supplied as the second argument in an array after the error level
175175
'jsdoc/require-example': [
176176
// The Error level should be `error`, `warn`, or `off` (or 2, 1, or 0)
177177
'error',
178-
// The options vary by rule, but are added to an options object:
178+
// The options vary by rule, but are generally added to an options
179+
// object as follows:
179180
{
180181
avoidExampleOnConstructors: true,
181182
exemptedBy: ['type']

0 commit comments

Comments
 (0)