Skip to content

Commit 9be6990

Browse files
edg2sG-Rath
andauthored
docs(valid-title): add documentation for ignoreTypeOfTestName option (#1842)
* Add missing documentation of ignoreTypeOfTestName option * Merge blocks, run prettier --------- Co-authored-by: Gareth Jones <3151613+G-Rath@users.noreply.github.com>
1 parent d7a67f3 commit 9be6990

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/rules/valid-title.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ describe('foo', () => {
175175
interface Options {
176176
ignoreSpaces?: boolean;
177177
ignoreTypeOfDescribeName?: boolean;
178+
ignoreTypeOfTestName?: boolean;
178179
disallowedWords?: string[];
179180
mustNotMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
180181
mustMatch?: Partial<Record<'describe' | 'test' | 'it', string>> | string;
@@ -187,12 +188,12 @@ Default: `false`
187188

188189
When enabled, the leading and trailing spaces won't be checked.
189190

190-
#### `ignoreTypeOfDescribeName`
191+
#### `ignoreTypeOfDescribeName` & `ignoreTypeOfTestName`
191192

192193
Default: `false`
193194

194-
When enabled, the type of the first argument to `describe` blocks won't be
195-
checked.
195+
When enabled, the type of the first argument to `describe`/`test` blocks won't
196+
be checked.
196197

197198
#### `disallowedWords`
198199

0 commit comments

Comments
 (0)