Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix grammatical errors in docs #13635

Merged
merged 1 commit into from
Dec 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
50 changes: 25 additions & 25 deletions docs/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ Use `describe.each` if you keep duplicating the same test suites with different
- To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`
- You can use `$#` to inject the index of the test case
- You cannot use `$variable` with the `printf` formatting except for `%%`
- `fn`: `Function` the suite of tests to be ran, this is the function that will receive the parameters in each row as function arguments.
- `fn`: `Function` the suite of tests to be run, this is the function that will receive the parameters in each row as function arguments.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.

Example:
Expand Down Expand Up @@ -305,7 +305,7 @@ describe.each([
- One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.
- `name`: `String` the title of the test suite, use `$variable` to inject test data into the suite title from the tagged template expressions, and `$#` for the index of the row.
- To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`
- `fn`: `Function` the suite of tests to be ran, this is the function that will receive the test data object.
- `fn`: `Function` the suite of tests to be run, this is the function that will receive the test data object.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.

Example:
Expand Down Expand Up @@ -374,7 +374,7 @@ describe.only.each([
});
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -393,7 +393,7 @@ describe.only.each`
});
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down Expand Up @@ -439,11 +439,11 @@ describe.skip.each([
[2, 1, 3],
])('.add(%i, %i)', (a, b, expected) => {
test(`returns ${expected}`, () => {
expect(a + b).toBe(expected); // will not be ran
expect(a + b).toBe(expected); // will not be run
});
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -457,12 +457,12 @@ describe.skip.each`
${1} | ${2} | ${3}
${2} | ${1} | ${3}
`('returns $expected when $a is added $b', ({a, b, expected}) => {
test('will not be ran', () => {
expect(a + b).toBe(expected); // will not be ran
test('will not be run', () => {
expect(a + b).toBe(expected); // will not be run
});
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down Expand Up @@ -551,7 +551,7 @@ Use `test.concurrent.each` if you keep duplicating the same test with different
- `%o` - Object.
- `%#` - Index of the test case.
- `%%` - single percent sign ('%'). This does not consume an argument.
- `fn`: `Function` the test to be ran, this is the function that will receive the parameters in each row as function arguments, **this will have to be an asynchronous function**.
- `fn`: `Function` the test to be run, this is the function that will receive the parameters in each row as function arguments, **this will have to be an asynchronous function**.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.

Example:
Expand All @@ -573,7 +573,7 @@ test.concurrent.each([
- One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.
- `name`: `String` the title of the test, use `$variable` to inject test data into the test title from the tagged template expressions.
- To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`
- `fn`: `Function` the test to be ran, this is the function that will receive the test data object, **this will have to be an asynchronous function**.
- `fn`: `Function` the test to be run, this is the function that will receive the test data object, **this will have to be an asynchronous function**.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.

Example:
Expand Down Expand Up @@ -608,7 +608,7 @@ test.concurrent.only.each([
expect(a + b).toBe(expected);
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -625,7 +625,7 @@ test.concurrent.only.each`
expect(a + b).toBe(expected);
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -646,10 +646,10 @@ test.concurrent.skip.each([
[1, 2, 3],
[2, 1, 3],
])('.add(%i, %i)', async (a, b, expected) => {
expect(a + b).toBe(expected); // will not be ran
expect(a + b).toBe(expected); // will not be run
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -663,10 +663,10 @@ test.concurrent.skip.each`
${1} | ${2} | ${3}
${2} | ${1} | ${3}
`('returns $expected when $a is added $b', async ({a, b, expected}) => {
expect(a + b).toBe(expected); // will not be ran
expect(a + b).toBe(expected); // will not be run
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down Expand Up @@ -697,7 +697,7 @@ Use `test.each` if you keep duplicating the same test with different data. `test
- To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`
- You can use `$#` to inject the index of the test case
- You cannot use `$variable` with the `printf` formatting except for `%%`
- `fn`: `Function` the test to be ran, this is the function that will receive the parameters in each row as function arguments.
- `fn`: `Function` the test to be run, this is the function that will receive the parameters in each row as function arguments.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.

Example:
Expand Down Expand Up @@ -729,7 +729,7 @@ test.each([
- One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.
- `name`: `String` the title of the test, use `$variable` to inject test data into the test title from the tagged template expressions.
- To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`
- `fn`: `Function` the test to be ran, this is the function that will receive the test data object.
- `fn`: `Function` the test to be run, this is the function that will receive the test data object.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. The default timeout is 5 seconds.

Example:
Expand Down Expand Up @@ -868,7 +868,7 @@ test.only.each([
expect(a + b).toBe(expected);
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -885,7 +885,7 @@ test.only.each`
expect(a + b).toBe(expected);
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down Expand Up @@ -928,10 +928,10 @@ test.skip.each([
[1, 2, 3],
[2, 1, 3],
])('.add(%i, %i)', (a, b, expected) => {
expect(a + b).toBe(expected); // will not be ran
expect(a + b).toBe(expected); // will not be run
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -945,10 +945,10 @@ test.skip.each`
${1} | ${2} | ${3}
${2} | ${1} | ${3}
`('returns $expected when $a is added $b', ({a, b, expected}) => {
expect(a + b).toBe(expected); // will not be ran
expect(a + b).toBe(expected); // will not be run
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down
34 changes: 17 additions & 17 deletions website/versioned_docs/version-25.x/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Use `describe.each` if you keep duplicating the same test suites with different
- `%o` - Object.
- `%#` - Index of the test case.
- `%%` - single percent sign ('%'). This does not consume an argument.
- `fn`: `Function` the suite of tests to be ran, this is the function that will receive the parameters in each row as function arguments.
- `fn`: `Function` the suite of tests to be run, this is the function that will receive the parameters in each row as function arguments.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. _Note: The default timeout is 5 seconds._

Example:
Expand Down Expand Up @@ -277,7 +277,7 @@ describe.each([
- One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.
- `name`: `String` the title of the test suite, use `$variable` to inject test data into the suite title from the tagged template expressions.
- To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`
- `fn`: `Function` the suite of tests to be ran, this is the function that will receive the test data object.
- `fn`: `Function` the suite of tests to be run, this is the function that will receive the test data object.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. _Note: The default timeout is 5 seconds._

Example:
Expand Down Expand Up @@ -346,7 +346,7 @@ describe.only.each([
});
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -365,7 +365,7 @@ describe.only.each`
});
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down Expand Up @@ -411,11 +411,11 @@ describe.skip.each([
[2, 1, 3],
])('.add(%i, %i)', (a, b, expected) => {
test(`returns ${expected}`, () => {
expect(a + b).toBe(expected); // will not be ran
expect(a + b).toBe(expected); // will not be run
});
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -429,12 +429,12 @@ describe.skip.each`
${1} | ${2} | ${3}
${2} | ${1} | ${3}
`('returns $expected when $a is added $b', ({a, b, expected}) => {
test('will not be ran', () => {
expect(a + b).toBe(expected); // will not be ran
test('will not be run', () => {
expect(a + b).toBe(expected); // will not be run
});
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down Expand Up @@ -490,7 +490,7 @@ Use `test.each` if you keep duplicating the same test with different data. `test
- `%o` - Object.
- `%#` - Index of the test case.
- `%%` - single percent sign ('%'). This does not consume an argument.
- `fn`: `Function` the test to be ran, this is the function that will receive the parameters in each row as function arguments.
- `fn`: `Function` the test to be run, this is the function that will receive the parameters in each row as function arguments.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. _Note: The default timeout is 5 seconds._

Example:
Expand All @@ -512,7 +512,7 @@ test.each([
- One or more subsequent rows of data supplied as template literal expressions using `${value}` syntax.
- `name`: `String` the title of the test, use `$variable` to inject test data into the test title from the tagged template expressions.
- To inject nested object values use you can supply a keyPath i.e. `$variable.path.to.value`
- `fn`: `Function` the test to be ran, this is the function that will receive the test data object.
- `fn`: `Function` the test to be run, this is the function that will receive the test data object.
- Optionally, you can provide a `timeout` (in milliseconds) for specifying how long to wait for each row before aborting. _Note: The default timeout is 5 seconds._

Example:
Expand Down Expand Up @@ -571,7 +571,7 @@ test.only.each([
expect(a + b).toBe(expected);
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -588,7 +588,7 @@ test.only.each`
expect(a + b).toBe(expected);
});

test('will not be ran', () => {
test('will not be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down Expand Up @@ -631,10 +631,10 @@ test.skip.each([
[1, 2, 3],
[2, 1, 3],
])('.add(%i, %i)', (a, b, expected) => {
expect(a + b).toBe(expected); // will not be ran
expect(a + b).toBe(expected); // will not be run
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand All @@ -648,10 +648,10 @@ test.skip.each`
${1} | ${2} | ${3}
${2} | ${1} | ${3}
`('returns $expected when $a is added $b', ({a, b, expected}) => {
expect(a + b).toBe(expected); // will not be ran
expect(a + b).toBe(expected); // will not be run
});

test('will be ran', () => {
test('will be run', () => {
expect(1 / 0).toBe(Infinity);
});
```
Expand Down