Skip to content

Commit 95f126d

Browse files
committed
docs(check-tag-names): add docs on rejecting tags
1 parent f3faa25 commit 95f126d

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,22 @@ typeSummary
174174
wizaction
175175
```
176176

177+
If you instead wish to reject a normally valid tag, e.g., `@todo`, one may set the
178+
tag to `false`:
179+
180+
```json
181+
{
182+
"rules": {},
183+
"settings": {
184+
"jsdoc": {
185+
"tagNamePreference": {
186+
"todo": false
187+
}
188+
}
189+
}
190+
}
191+
```
192+
177193
#### Options
178194

179195
##### `definedTags`

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4471,6 +4471,22 @@ typeSummary
44714471
wizaction
44724472
```
44734473

4474+
If you instead wish to reject a normally valid tag, e.g., `@todo`, one may set the
4475+
tag to `false`:
4476+
4477+
```json
4478+
{
4479+
"rules": {},
4480+
"settings": {
4481+
"jsdoc": {
4482+
"tagNamePreference": {
4483+
"todo": false
4484+
}
4485+
}
4486+
}
4487+
}
4488+
```
4489+
44744490
<a name="user-content-eslint-plugin-jsdoc-rules-check-tag-names-options-6"></a>
44754491
<a name="eslint-plugin-jsdoc-rules-check-tag-names-options-6"></a>
44764492
#### Options

0 commit comments

Comments
 (0)