Skip to content

Commit 47559e6

Browse files
committed
docs(check-tag-names): minor doc issues
1 parent cebf94f commit 47559e6

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

.README/rules/check-tag-names.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ The format is as follows:
191191

192192
Set to `false` to disable auto-removal of types that are redundant with the [`typed` option](#typed).
193193

194-
#### `jsxTags`
194+
##### `jsxTags`
195195

196196
If this is set to `true`, all of the following tags used to control JSX output are allowed:
197197

@@ -204,7 +204,7 @@ jsxRuntime
204204

205205
For more information, see the [babel documentation](https://babeljs.io/docs/en/babel-plugin-transform-react-jsx).
206206

207-
#### `typed`
207+
##### `typed`
208208

209209
If this is set to `true`, additionally checks for tag names that are redundant when using a type checker such as TypeScript.
210210

@@ -259,14 +259,12 @@ static
259259
this
260260
```
261261

262-
Additionally, for `@param` and `@return` tags, the rule will flag unnecessary type descriptions (e.g. `@param {string}`).
263-
264262
|||
265263
|---|---|
266264
|Context|everywhere|
267265
|Tags|N/A|
268266
|Recommended|true|
269-
|Options|`definedTags`|
267+
|Options|`definedTags`, `enableFixer`, `jsxTags`, `typed`|
270268
|Settings|`tagNamePreference`, `mode`|
271269

272270
<!-- assertions checkTagNames -->

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4492,9 +4492,9 @@ The format is as follows:
44924492

44934493
Set to `false` to disable auto-removal of types that are redundant with the [`typed` option](#user-content-typed).
44944494

4495-
<a name="user-content-eslint-plugin-jsdoc-rules-check-tag-names-jsxtags"></a>
4496-
<a name="eslint-plugin-jsdoc-rules-check-tag-names-jsxtags"></a>
4497-
#### <code>jsxTags</code>
4495+
<a name="user-content-eslint-plugin-jsdoc-rules-check-tag-names-options-6-jsxtags"></a>
4496+
<a name="eslint-plugin-jsdoc-rules-check-tag-names-options-6-jsxtags"></a>
4497+
##### <code>jsxTags</code>
44984498

44994499
If this is set to `true`, all of the following tags used to control JSX output are allowed:
45004500

@@ -4507,9 +4507,9 @@ jsxRuntime
45074507

45084508
For more information, see the [babel documentation](https://babeljs.io/docs/en/babel-plugin-transform-react-jsx).
45094509

4510-
<a name="user-content-eslint-plugin-jsdoc-rules-check-tag-names-typed"></a>
4511-
<a name="eslint-plugin-jsdoc-rules-check-tag-names-typed"></a>
4512-
#### <code>typed</code>
4510+
<a name="user-content-eslint-plugin-jsdoc-rules-check-tag-names-options-6-typed"></a>
4511+
<a name="eslint-plugin-jsdoc-rules-check-tag-names-options-6-typed"></a>
4512+
##### <code>typed</code>
45134513

45144514
If this is set to `true`, additionally checks for tag names that are redundant when using a type checker such as TypeScript.
45154515

@@ -4564,14 +4564,12 @@ static
45644564
this
45654565
```
45664566

4567-
Additionally, for `@param` and `@return` tags, the rule will flag unnecessary type descriptions (e.g. `@param {string}`).
4568-
45694567
|||
45704568
|---|---|
45714569
|Context|everywhere|
45724570
|Tags|N/A|
45734571
|Recommended|true|
4574-
|Options|`definedTags`|
4572+
|Options|`definedTags`, `enableFixer`, `jsxTags`, `typed`|
45754573
|Settings|`tagNamePreference`, `mode`|
45764574

45774575
The following patterns are considered problems:

0 commit comments

Comments
 (0)