Skip to content

Commit de508e3

Browse files
authored
Add warning about invalid tag characters to docs (#1448)
1 parent 5b98269 commit de508e3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

packages/docs/src/content/docs/reference/configuration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,13 @@ notation below is valid and will report only exports tagged `@lintignore` or
180180
}
181181
```
182182

183+
:::caution
184+
185+
Tags must not contain hyphens or plus symbols, so it is recommended to stick to
186+
letters and avoid snake-case.
187+
188+
:::
189+
183190
Also see [JSDoc & TSDoc Tags][8].
184191

185192
### `treatConfigHintsAsErrors`

0 commit comments

Comments
 (0)