Skip to content

Commit 6b5c56f

Browse files
authored
docs: grammar and spelling fixes (#1086)
1 parent 67daa2f commit 6b5c56f

12 files changed

+16
-17
lines changed

Diff for: README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -239,8 +239,8 @@ adjust your eslint config as outlined
239239

240240
Note that unlike the type-checking rules in `@typescript-eslint/eslint-plugin`,
241241
the rules here will fallback to doing nothing if type information is not
242-
available, meaning its safe to include them in shared configs that could be used
243-
on JavaScript and TypeScript projects.
242+
available, meaning it's safe to include them in shared configs that could be
243+
used on JavaScript and TypeScript projects.
244244

245245
Also note that `unbound-method` depends on `@typescript-eslint/eslint-plugin`,
246246
as it extends the original `unbound-method` rule from that plugin.

Diff for: docs/rules/no-conditional-expect.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ While you can use `expect.assertions` & `expect.hasAssertions` for these
107107
situations, they only work with `expect`.
108108

109109
A better way to handle this situation is to introduce a wrapper to handle the
110-
catching, and otherwise returns a specific "no error thrown" error if nothing is
110+
catching, and otherwise return a specific "no error thrown" error if nothing is
111111
thrown by the wrapped function:
112112

113113
```typescript

Diff for: docs/rules/no-deprecated-functions.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@ Originally, the `requireActual` & `requireMock` the `requireActual`&
3737

3838
These functions were later moved onto the `jest` object in order to be easier
3939
for type checkers to handle, and their use via `require` deprecated. Finally,
40-
the release of Jest 26 saw them removed from the `require` function all
41-
together.
40+
the release of Jest 26 saw them removed from the `require` function altogether.
4241

4342
### `jest.runTimersToTime`
4443

Diff for: docs/rules/no-identical-title.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ fix.
77

88
## Rule Details
99

10-
This rule looks at the title of every test and test suites. It will report when
10+
This rule looks at the title of every test and test suite. It will report when
1111
two test suites or two test cases at the same level of a test suite have the
1212
same title.
1313

Diff for: docs/rules/no-jasmine-globals.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ API.
99

1010
### Rule details
1111

12-
This rule reports on any usage of Jasmine globals which is not ported to Jest,
13-
and suggests alternative from Jest's own API.
12+
This rule reports on any usage of Jasmine globals, which is not ported to Jest,
13+
and suggests alternatives from Jest's own API.
1414

1515
### Default configuration
1616

Diff for: docs/rules/no-jest-import.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ first place.
1717

1818
## Further Reading
1919

20-
\*[The Jest Object](https://facebook.github.io/jest/docs/en/jest-object.html)
20+
- [The Jest Object](https://facebook.github.io/jest/docs/en/jest-object.html)

Diff for: docs/rules/no-large-snapshots.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ External). Use `inlineMaxSize` for
118118
[Inline Snapshots](https://jestjs.io/docs/en/snapshot-testing#inline-snapshots)
119119
size and `maxSize` for
120120
[External Snapshots](https://jestjs.io/docs/en/snapshot-testing#snapshot-testing-with-jest).
121-
If only `maxSize` is provided on options, the value of `maxSize` will be used to
122-
both snapshot types (Inline and External).
121+
If only `maxSize` is provided on options, the value of `maxSize` will be used
122+
for both snapshot types (Inline and External).
123123

124124
Since `eslint-disable` comments are not preserved by Jest when updating
125125
snapshots, you can use the `allowedSnapshots` option to have specific snapshots

Diff for: docs/rules/no-standalone-expect.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ describe('a test', () => {
6161
```
6262

6363
\*Note that this rule will not trigger if the helper function is never used even
64-
thought the `expect` will not execute. Rely on a rule like no-unused-vars for
64+
though the `expect` will not execute. Rely on a rule like no-unused-vars for
6565
this case.
6666

6767
### Options

Diff for: docs/rules/prefer-comparison-matcher.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Suggest using the built-in comparison matchers (`prefer-comparison-matcher`)
22

3-
Jest has a number of built-in matchers for comparing numbers which allow for
3+
Jest has a number of built-in matchers for comparing numbers, which allow for
44
more readable tests and error messages if an expectation fails.
55

66
## Rule details

Diff for: docs/rules/prefer-equality-matcher.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Suggest using the built-in equality matchers (`prefer-equality-matcher`)
22

3-
Jest has built-in matchers for expecting equality which allow for more readable
3+
Jest has built-in matchers for expecting equality, which allow for more readable
44
tests and error messages if an expectation fails.
55

66
## Rule details

Diff for: docs/rules/prefer-hooks-on-top.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Suggest having hooks before any test cases (`prefer-hooks-on-top`)
22

33
While hooks can be setup anywhere in a test file, they are always called in a
4-
specific order which means it can be confusing if they're intermixed with test
4+
specific order, which means it can be confusing if they're intermixed with test
55
cases.
66

77
This rule helps to ensure that hooks are always defined before test cases.

Diff for: docs/rules/prefer-lowercase-title.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ it('Uppercase description');
7373

7474
### `allowedPrefixes`
7575

76-
This array option allows specifying prefixes which contain capitals that titles
77-
can start with. This can be useful when writing tests for api endpoints, where
76+
This array option allows specifying prefixes, which contain capitals that titles
77+
can start with. This can be useful when writing tests for API endpoints, where
7878
you'd like to prefix with the HTTP method.
7979

8080
By default, nothing is allowed (the equivalent of `{ "allowedPrefixes": [] }`).

0 commit comments

Comments
 (0)