Skip to content

Commit 16fad4e

Browse files
committed
fix(valid-expect-in-promise): rewrite rule description to be clearer
1 parent a1dced4 commit 16fad4e

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ installations requiring long-term consistency.
193193
| [require-top-level-describe](docs/rules/require-top-level-describe.md) | Require test cases and hooks to be inside a `describe` block | | |
194194
| [valid-describe](docs/rules/valid-describe.md) | Enforce valid `describe()` callback | ![recommended][] | |
195195
| [valid-expect](docs/rules/valid-expect.md) | Enforce valid `expect()` usage | ![recommended][] | |
196-
| [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md) | Enforce having return statement when testing with promises | ![recommended][] | |
196+
| [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md) | Ensure promises that have expectations in their chain are valid | ![recommended][] | |
197197
| [valid-title](docs/rules/valid-title.md) | Enforce valid titles | ![recommended][] | ![fixable][] |
198198

199199
<!-- end base rules list -->

docs/rules/valid-expect-in-promise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Enforce having return statement when testing with promises (`valid-expect-in-promise`)
1+
# Ensure promises that have expectations in their chain are valid (`valid-expect-in-promise`)
22

33
Ensure to return promise when having assertions in `then` or `catch` block of
44
promise

src/rules/valid-expect-in-promise.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,8 @@ export default createRule({
219219
meta: {
220220
docs: {
221221
category: 'Best Practices',
222-
description: 'Enforce having return statement when testing with promises',
222+
description:
223+
'Ensure promises that have expectations in their chain are valid',
223224
recommended: 'error',
224225
},
225226
messages: {

0 commit comments

Comments
 (0)