Skip to content

Commit fea6b88

Browse files
committed
docs(check-examples): fix heading level
1 parent df00b33 commit fea6b88

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

.README/rules/check-examples.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.
44

5-
### Options
5+
#### Options
66

77
The options below all default to no-op/`false` except as noted.
88

9-
#### `captionRequired`
9+
##### `captionRequired`
1010

1111
JSDoc specs use of an optional `<caption>` element at the beginning of
1212
`@example`.
1313

1414
The option `captionRequired` insists on a `<caption>` being present at
1515
the beginning of any `@example`.
1616

17-
#### `exampleCodeRegex` and `rejectExampleCodeRegex`
17+
##### `exampleCodeRegex` and `rejectExampleCodeRegex`
1818

1919
JSDoc does not specify a formal means for delimiting code blocks within
2020
`@example` (it uses generic syntax highlighting techniques for its own
@@ -37,7 +37,7 @@ If neither is in use, all examples will be matched. Note also that even if
3737
`captionRequired` is not set, any initial `<caption>` will be stripped out
3838
before doing the regex matching.
3939

40-
#### `paddedIndent`
40+
##### `paddedIndent`
4141

4242
This integer property allows one to add a fixed amount of whitespace at the
4343
beginning of the second or later lines of the example to be stripped so as
@@ -55,7 +55,7 @@ out before evaluation.
5555
*/
5656
```
5757

58-
#### `reportUnusedDisableDirectives`
58+
##### `reportUnusedDisableDirectives`
5959

6060
If not set to `false`, `reportUnusedDisableDirectives` will report disabled
6161
directives which are not used (and thus not needed). Defaults to `true`.

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ JSDoc linting rules for ESLint.
1919
* [Rules](#eslint-plugin-jsdoc-rules)
2020
* [`check-alignment`](#eslint-plugin-jsdoc-rules-check-alignment)
2121
* [`check-examples`](#eslint-plugin-jsdoc-rules-check-examples)
22-
* [Options](#eslint-plugin-jsdoc-rules-options)
2322
* [`check-indentation`](#eslint-plugin-jsdoc-rules-check-indentation)
2423
* [`check-param-names`](#eslint-plugin-jsdoc-rules-check-param-names)
2524
* [`check-syntax`](#eslint-plugin-jsdoc-rules-check-syntax)
@@ -427,22 +426,22 @@ function quux (foo) {}
427426

428427
Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.
429428

430-
<a name="eslint-plugin-jsdoc-rules-options"></a>
431-
### Options
429+
<a name="eslint-plugin-jsdoc-rules-check-examples-options"></a>
430+
#### Options
432431

433432
The options below all default to no-op/`false` except as noted.
434433

435-
<a name="eslint-plugin-jsdoc-rules-options-captionrequired"></a>
436-
#### <code>captionRequired</code>
434+
<a name="eslint-plugin-jsdoc-rules-check-examples-options-captionrequired"></a>
435+
##### <code>captionRequired</code>
437436

438437
JSDoc specs use of an optional `<caption>` element at the beginning of
439438
`@example`.
440439

441440
The option `captionRequired` insists on a `<caption>` being present at
442441
the beginning of any `@example`.
443442

444-
<a name="eslint-plugin-jsdoc-rules-options-examplecoderegex-and-rejectexamplecoderegex"></a>
445-
#### <code>exampleCodeRegex</code> and <code>rejectExampleCodeRegex</code>
443+
<a name="eslint-plugin-jsdoc-rules-check-examples-options-examplecoderegex-and-rejectexamplecoderegex"></a>
444+
##### <code>exampleCodeRegex</code> and <code>rejectExampleCodeRegex</code>
446445

447446
JSDoc does not specify a formal means for delimiting code blocks within
448447
`@example` (it uses generic syntax highlighting techniques for its own
@@ -465,8 +464,8 @@ If neither is in use, all examples will be matched. Note also that even if
465464
`captionRequired` is not set, any initial `<caption>` will be stripped out
466465
before doing the regex matching.
467466

468-
<a name="eslint-plugin-jsdoc-rules-options-paddedindent"></a>
469-
#### <code>paddedIndent</code>
467+
<a name="eslint-plugin-jsdoc-rules-check-examples-options-paddedindent"></a>
468+
##### <code>paddedIndent</code>
470469

471470
This integer property allows one to add a fixed amount of whitespace at the
472471
beginning of the second or later lines of the example to be stripped so as
@@ -484,8 +483,8 @@ out before evaluation.
484483
*/
485484
```
486485

487-
<a name="eslint-plugin-jsdoc-rules-options-reportunuseddisabledirectives"></a>
488-
#### <code>reportUnusedDisableDirectives</code>
486+
<a name="eslint-plugin-jsdoc-rules-check-examples-options-reportunuseddisabledirectives"></a>
487+
##### <code>reportUnusedDisableDirectives</code>
489488

490489
If not set to `false`, `reportUnusedDisableDirectives` will report disabled
491490
directives which are not used (and thus not needed). Defaults to `true`.
@@ -496,7 +495,7 @@ disabling of ESLint directives which are not needed by the resolved rules
496495
will be reported as with the ESLint `--report-unused-disable-directives`
497496
command.
498497

499-
<a name="eslint-plugin-jsdoc-rules-options-options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-eslintrcforexamples-and-baseconfig"></a>
498+
<a name="eslint-plugin-jsdoc-rules-check-examples-options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-eslintrcforexamples-and-baseconfig"></a>
500499
#### Options for Determining ESLint Rule Applicability (<code>allowInlineConfig</code>, <code>noDefaultExampleRules</code>, <code>matchingFileName</code>, <code>configFile</code>, <code>eslintrcForExamples</code>, and <code>baseConfig</code>)
501500

502501
The following options determine which individual ESLint rules will be
@@ -527,7 +526,7 @@ decreasing precedence:
527526
* `baseConfig` - An object of rules with the same schema
528527
as `.eslintrc.*` for defaults
529528

530-
<a name="eslint-plugin-jsdoc-rules-options-options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-eslintrcforexamples-and-baseconfig-rules-disabled-by-default-unless-nodefaultexamplerules-is-set-to-true"></a>
529+
<a name="eslint-plugin-jsdoc-rules-check-examples-options-for-determining-eslint-rule-applicability-allowinlineconfig-nodefaultexamplerules-matchingfilename-configfile-eslintrcforexamples-and-baseconfig-rules-disabled-by-default-unless-nodefaultexamplerules-is-set-to-true"></a>
531530
##### Rules Disabled by Default Unless <code>noDefaultExampleRules</code> is Set to <code>true</code>
532531

533532
* `eol-last` - Insisting that a newline "always" be at the end is less likely

0 commit comments

Comments
 (0)