Skip to content

Commit f308667

Browse files
committed
docs(no-bad-blocks): clarify preventAllMultiAsteriskBlocks option; fixes #784
1 parent e793c66 commit f308667

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.README/rules/no-bad-blocks.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ Defaults to `['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck']`
2121
##### `preventAllMultiAsteriskBlocks`
2222

2323
A boolean (defaulting to `false`) which if `true` will prevent all
24-
multi-asterisked blocks even those without apparent tag content.
24+
JSDoc-like blocks with more than two initial asterisks even those without
25+
apparent tag content.
2526

2627
|||
2728
|---|---|

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8170,7 +8170,8 @@ Defaults to `['ts-check', 'ts-expect-error', 'ts-ignore', 'ts-nocheck']`
81708170
##### <code>preventAllMultiAsteriskBlocks</code>
81718171

81728172
A boolean (defaulting to `false`) which if `true` will prevent all
8173-
multi-asterisked blocks even those without apparent tag content.
8173+
JSDoc-like blocks with more than two initial asterisks even those without
8174+
apparent tag content.
81748175

81758176
|||
81768177
|---|---|

0 commit comments

Comments
 (0)