Skip to content

Commit 2993a4f

Browse files
rnwstrnwst
authored
docs: fix various grammatical errors (#13768)
1 parent 49204ac commit 2993a4f

File tree

15 files changed

+36
-36
lines changed

15 files changed

+36
-36
lines changed

‎docs/GlobalAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {
525525

526526
:::tip
527527

528-
Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
528+
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.
529529

530530
:::
531531

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

760760
:::tip
761761

762-
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.
762+
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.
763763

764764
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.
765765

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

968968
:::tip
969969

970-
`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.
970+
`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.
971971

972972
:::
973973

‎docs/JestObjectAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ Returns the `jest` object for chaining.
344344

345345
:::tip
346346

347-
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.
347+
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.
348348

349349
:::
350350

@@ -604,7 +604,7 @@ console.log(returnsTrue()); // true;
604604

605605
:::tip
606606

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

609609
:::
610610

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

674674
:::tip
675675

676-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
676+
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.
677677

678678
:::
679679

‎website/versioned_docs/version-25.x/JestObjectAPI.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha
479479

480480
:::tip
481481

482-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
482+
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.
483483

484484
:::
485485

‎website/versioned_docs/version-26.x/JestObjectAPI.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha
483483

484484
:::tip
485485

486-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
486+
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.
487487

488488
:::
489489

‎website/versioned_docs/version-27.x/JestObjectAPI.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ By default, `jest.spyOn` also calls the **spied** method. This is different beha
483483

484484
:::tip
485485

486-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
486+
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.
487487

488488
:::
489489

‎website/versioned_docs/version-28.x/GlobalAPI.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -745,7 +745,7 @@ Use `test.failing` when you are writing a test and expecting it to fail. These t
745745

746746
:::tip
747747

748-
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.
748+
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.
749749

750750
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.
751751

‎website/versioned_docs/version-28.x/JestObjectAPI.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ console.log(returnsTrue()); // true;
469469

470470
:::note
471471

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

474474
:::
475475

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

490490
:::tip
491491

492-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
492+
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.
493493

494494
:::
495495

‎website/versioned_docs/version-29.0/GlobalAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {
525525

526526
:::tip
527527

528-
Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
528+
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.
529529

530530
:::
531531

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

760760
:::tip
761761

762-
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.
762+
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.
763763

764764
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.
765765

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

968968
:::tip
969969

970-
`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.
970+
`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.
971971

972972
:::
973973

‎website/versioned_docs/version-29.0/JestObjectAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ Returns the `jest` object for chaining.
312312

313313
:::tip
314314

315-
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.
315+
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.
316316

317317
:::
318318

@@ -513,7 +513,7 @@ console.log(returnsTrue()); // true;
513513

514514
:::tip
515515

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

518518
:::
519519

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

534534
:::tip
535535

536-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
536+
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.
537537

538538
:::
539539

‎website/versioned_docs/version-29.1/GlobalAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {
525525

526526
:::tip
527527

528-
Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
528+
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.
529529

530530
:::
531531

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

760760
:::tip
761761

762-
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.
762+
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.
763763

764764
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.
765765

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

968968
:::tip
969969

970-
`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.
970+
`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.
971971

972972
:::
973973

‎website/versioned_docs/version-29.1/JestObjectAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ Returns the `jest` object for chaining.
344344

345345
:::tip
346346

347-
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.
347+
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.
348348

349349
:::
350350

@@ -586,7 +586,7 @@ console.log(returnsTrue()); // true;
586586

587587
:::tip
588588

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

591591
:::
592592

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

607607
:::tip
608608

609-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
609+
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.
610610

611611
:::
612612

‎website/versioned_docs/version-29.2/GlobalAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {
525525

526526
:::tip
527527

528-
Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
528+
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.
529529

530530
:::
531531

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

760760
:::tip
761761

762-
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.
762+
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.
763763

764764
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.
765765

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

968968
:::tip
969969

970-
`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.
970+
`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.
971971

972972
:::
973973

‎website/versioned_docs/version-29.2/JestObjectAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ Returns the `jest` object for chaining.
344344

345345
:::tip
346346

347-
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.
347+
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.
348348

349349
:::
350350

@@ -586,7 +586,7 @@ console.log(returnsTrue()); // true;
586586

587587
:::tip
588588

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

591591
:::
592592

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

607607
:::tip
608608

609-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
609+
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.
610610

611611
:::
612612

‎website/versioned_docs/version-29.3/GlobalAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ test.concurrent('subtraction 2 numbers', async () => {
525525

526526
:::tip
527527

528-
Use [`maxConcurrency`](Configuration.md/#maxconcurrency-number) configuration option to prevent Jest from executing more than the specified amount of tests at the same time.
528+
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.
529529

530530
:::
531531

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

760760
:::tip
761761

762-
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.
762+
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.
763763

764764
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.
765765

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

968968
:::tip
969969

970-
`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.
970+
`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.
971971

972972
:::
973973

‎website/versioned_docs/version-29.3/JestObjectAPI.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ Returns the `jest` object for chaining.
344344

345345
:::tip
346346

347-
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.
347+
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.
348348

349349
:::
350350

@@ -586,7 +586,7 @@ console.log(returnsTrue()); // true;
586586

587587
:::tip
588588

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

591591
:::
592592

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

607607
:::tip
608608

609-
Since `jest.spyOn` is a mock, you could restore the initial state calling [jest.restoreAllMocks](#jestrestoreallmocks) on [afterEach](GlobalAPI.md#aftereachfn-timeout) method.
609+
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.
610610

611611
:::
612612

0 commit comments

Comments
 (0)