Skip to content

Commit

Permalink
docs: fix various grammatical errors (#13768)
Browse files Browse the repository at this point in the history
  • Loading branch information
rnwst committed Jan 15, 2023
1 parent 49204ac commit 2993a4f
Show file tree
Hide file tree
Showing 15 changed files with 36 additions and 36 deletions.
6 changes: 3 additions & 3 deletions docs/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {

:::tip

Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
Use the [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.

:::

Expand Down Expand Up @@ -759,7 +759,7 @@ Use `test.failing` when you are writing a test and expecting it to fail. These t

:::tip

You can use this type of tests i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.
You can use this type of test i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.

It can also be a nice way to contribute failing tests to a project, even if you don't know how to fix the bug.

Expand Down Expand Up @@ -967,7 +967,7 @@ test.todo('add should be associative');

:::tip

`test.todo` will throw an error, if you will pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.
`test.todo` will throw an error if you pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.

:::

Expand Down
6 changes: 3 additions & 3 deletions docs/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ Returns the `jest` object for chaining.

:::tip

Writing tests in TypeScript? Use [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.
Writing tests in TypeScript? Use the [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or the [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.

:::

Expand Down Expand Up @@ -604,7 +604,7 @@ console.log(returnsTrue()); // true;

:::tip

See [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.
See the [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.

:::

Expand Down Expand Up @@ -673,7 +673,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-25.x/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-26.x/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-27.x/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-28.x/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ Use `test.failing` when you are writing a test and expecting it to fail. These t

:::tip

You can use this type of tests i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.
You can use this type of test i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.

It can also be a nice way to contribute failing tests to a project, even if you don't know how to fix the bug.

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-28.x/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,7 @@ console.log(returnsTrue()); // true;

:::note

See [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.
See the [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.

:::

Expand All @@ -489,7 +489,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-29.0/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {

:::tip

Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
Use the [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.

:::

Expand Down Expand Up @@ -759,7 +759,7 @@ Use `test.failing` when you are writing a test and expecting it to fail. These t

:::tip

You can use this type of tests i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.
You can use this type of test i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.

It can also be a nice way to contribute failing tests to a project, even if you don't know how to fix the bug.

Expand Down Expand Up @@ -967,7 +967,7 @@ test.todo('add should be associative');

:::tip

`test.todo` will throw an error, if you will pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.
`test.todo` will throw an error if you pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.

:::

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-29.0/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ Returns the `jest` object for chaining.

:::tip

Writing tests in TypeScript? Use [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.
Writing tests in TypeScript? Use the [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or the [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.

:::

Expand Down Expand Up @@ -513,7 +513,7 @@ console.log(returnsTrue()); // true;

:::tip

See [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.
See the [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.

:::

Expand All @@ -533,7 +533,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-29.1/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {

:::tip

Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
Use the [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.

:::

Expand Down Expand Up @@ -759,7 +759,7 @@ Use `test.failing` when you are writing a test and expecting it to fail. These t

:::tip

You can use this type of tests i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.
You can use this type of test i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.

It can also be a nice way to contribute failing tests to a project, even if you don't know how to fix the bug.

Expand Down Expand Up @@ -967,7 +967,7 @@ test.todo('add should be associative');

:::tip

`test.todo` will throw an error, if you will pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.
`test.todo` will throw an error if you pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.

:::

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-29.1/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ Returns the `jest` object for chaining.

:::tip

Writing tests in TypeScript? Use [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.
Writing tests in TypeScript? Use the [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or the [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.

:::

Expand Down Expand Up @@ -586,7 +586,7 @@ console.log(returnsTrue()); // true;

:::tip

See [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.
See the [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.

:::

Expand All @@ -606,7 +606,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-29.2/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {

:::tip

Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
Use the [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.

:::

Expand Down Expand Up @@ -759,7 +759,7 @@ Use `test.failing` when you are writing a test and expecting it to fail. These t

:::tip

You can use this type of tests i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.
You can use this type of test i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.

It can also be a nice way to contribute failing tests to a project, even if you don't know how to fix the bug.

Expand Down Expand Up @@ -967,7 +967,7 @@ test.todo('add should be associative');

:::tip

`test.todo` will throw an error, if you will pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.
`test.todo` will throw an error if you pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.

:::

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-29.2/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ Returns the `jest` object for chaining.

:::tip

Writing tests in TypeScript? Use [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.
Writing tests in TypeScript? Use the [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or the [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.

:::

Expand Down Expand Up @@ -586,7 +586,7 @@ console.log(returnsTrue()); // true;

:::tip

See [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.
See the [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.

:::

Expand All @@ -606,7 +606,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-29.3/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {

:::tip

Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
Use the [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.

:::

Expand Down Expand Up @@ -759,7 +759,7 @@ Use `test.failing` when you are writing a test and expecting it to fail. These t

:::tip

You can use this type of tests i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.
You can use this type of test i.e. when writing code in a BDD way. In that case the tests will not show up as failing until they pass. Then you can just remove the `failing` modifier to make them pass.

It can also be a nice way to contribute failing tests to a project, even if you don't know how to fix the bug.

Expand Down Expand Up @@ -967,7 +967,7 @@ test.todo('add should be associative');

:::tip

`test.todo` will throw an error, if you will pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.
`test.todo` will throw an error if you pass it a test callback function. Use [`test.skip`](#testskipname-fn) instead, if you already implemented the test, but do not want it to run.

:::

Expand Down
6 changes: 3 additions & 3 deletions website/versioned_docs/version-29.3/JestObjectAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ Returns the `jest` object for chaining.

:::tip

Writing tests in TypeScript? Use [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.
Writing tests in TypeScript? Use the [`jest.Mocked`](MockFunctionAPI.md/#jestmockedsource) utility type or the [`jest.mocked()`](MockFunctionAPI.md/#jestmockedsource-options) helper method to have your mocked modules typed.

:::

Expand Down Expand Up @@ -586,7 +586,7 @@ console.log(returnsTrue()); // true;

:::tip

See [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.
See the [Mock Functions](MockFunctionAPI.md#jestfnimplementation) page for details on TypeScript usage.

:::

Expand All @@ -606,7 +606,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha

:::tip

Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
Since `jest.spyOn` is a mock, you could restore the initial state by calling [`jest.restoreAllMocks`](#jestrestoreallmocks) in the body of the callback passed to the [afterEach](GlobalAPI.md#aftereachfn-timeout) hook.

:::

Expand Down

0 comments on commit 2993a4f

Please sign in to comment.