Commit 1f9246a
doc: copyedit test.md
PR-URL: #44061
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Feng Yu <F3n67u@outlook.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>1 parent bfdee25 commit 1f9246a
1 file changed
Lines changed: 12 additions & 12 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -154,7 +154,7 @@ Running tests can also be done using `describe` to declare a suite | |||
| 154 | 154 | and `it` to declare a test. | |
| 155 | 155 | A suite is used to organize and group related tests together. | |
| 156 | 156 | `it` is an alias for `test`, except there is no test context passed, | |
| 157 | - since nesting is done using suites, as demonstrated in this example | ||
| 157 | + since nesting is done using suites. | ||
| 158 | 158 | ||
| 159 | 159 | ```js | |
| 160 | 160 | describe('A thing', () => { | |
@@ -174,7 +174,7 @@ describe('A thing', () => { | |||
| 174 | 174 | }); | |
| 175 | 175 | ``` | |
| 176 | 176 | ||
| 177 | - `describe` and `it` are imported from the `node:test` module | ||
| 177 | + `describe` and `it` are imported from the `node:test` module. | ||
| 178 | 178 | ||
| 179 | 179 | ```mjs | |
| 180 | 180 | import { describe, it } from 'node:test'; | |
@@ -398,7 +398,7 @@ thus prevent the scheduled cancellation. | |||
| 398 | 398 | results. **Default:** The `name` property of `fn`, or `'<anonymous>'` if `fn` | |
| 399 | 399 | does not have a name. | |
| 400 | 400 | * `options` {Object} Configuration options for the suite. | |
| 401 | - supports the same options as `test([name][, options][, fn])` | ||
| 401 | + supports the same options as `test([name][, options][, fn])`. | ||
| 402 | 402 | * `fn` {Function|AsyncFunction} The function under suite | |
| 403 | 403 | declaring all subtests and subsuites. | |
| 404 | 404 | The first argument to this function is a [`SuiteContext`][] object. | |
@@ -409,7 +409,7 @@ The `describe()` function imported from the `node:test` module. Each | |||
| 409 | 409 | invocation of this function results in the creation of a Subtest | |
| 410 | 410 | and a test point in the TAP output. | |
| 411 | 411 | After invocation of top level `describe` functions, | |
| 412 | - all top level tests and suites will execute | ||
| 412 | + all top level tests and suites will execute. | ||
| 413 | 413 | ||
| 414 | 414 | ## `describe.skip([name][, options][, fn])` | |
| 415 | 415 | ||
@@ -458,7 +458,7 @@ added: REPLACEME | |||
| 458 | 458 | function. | |
| 459 | 459 | * `options` {Object} Configuration options for the hook. The following | |
| 460 | 460 | properties are supported: | |
| 461 | - * `signal` {AbortSignal} Allows aborting an in-progress hook | ||
| 461 | + * `signal` {AbortSignal} Allows aborting an in-progress hook. | ||
| 462 | 462 | * `timeout` {number} A number of milliseconds the hook will fail after. | |
| 463 | 463 | If unspecified, subtests inherit this value from their parent. | |
| 464 | 464 | **Default:** `Infinity`. | |
@@ -486,7 +486,7 @@ added: REPLACEME | |||
| 486 | 486 | function. | |
| 487 | 487 | * `options` {Object} Configuration options for the hook. The following | |
| 488 | 488 | properties are supported: | |
| 489 | - * `signal` {AbortSignal} Allows aborting an in-progress hook | ||
| 489 | + * `signal` {AbortSignal} Allows aborting an in-progress hook. | ||
| 490 | 490 | * `timeout` {number} A number of milliseconds the hook will fail after. | |
| 491 | 491 | If unspecified, subtests inherit this value from their parent. | |
| 492 | 492 | **Default:** `Infinity`. | |
@@ -514,7 +514,7 @@ added: REPLACEME | |||
| 514 | 514 | function. | |
| 515 | 515 | * `options` {Object} Configuration options for the hook. The following | |
| 516 | 516 | properties are supported: | |
| 517 | - * `signal` {AbortSignal} Allows aborting an in-progress hook | ||
| 517 | + * `signal` {AbortSignal} Allows aborting an in-progress hook. | ||
| 518 | 518 | * `timeout` {number} A number of milliseconds the hook will fail after. | |
| 519 | 519 | If unspecified, subtests inherit this value from their parent. | |
| 520 | 520 | **Default:** `Infinity`. | |
@@ -543,7 +543,7 @@ added: REPLACEME | |||
| 543 | 543 | function. | |
| 544 | 544 | * `options` {Object} Configuration options for the hook. The following | |
| 545 | 545 | properties are supported: | |
| 546 | - * `signal` {AbortSignal} Allows aborting an in-progress hook | ||
| 546 | + * `signal` {AbortSignal} Allows aborting an in-progress hook. | ||
| 547 | 547 | * `timeout` {number} A number of milliseconds the hook will fail after. | |
| 548 | 548 | If unspecified, subtests inherit this value from their parent. | |
| 549 | 549 | **Default:** `Infinity`. | |
@@ -582,7 +582,7 @@ added: REPLACEME | |||
| 582 | 582 | function. | |
| 583 | 583 | * `options` {Object} Configuration options for the hook. The following | |
| 584 | 584 | properties are supported: | |
| 585 | - * `signal` {AbortSignal} Allows aborting an in-progress hook | ||
| 585 | + * `signal` {AbortSignal} Allows aborting an in-progress hook. | ||
| 586 | 586 | * `timeout` {number} A number of milliseconds the hook will fail after. | |
| 587 | 587 | If unspecified, subtests inherit this value from their parent. | |
| 588 | 588 | **Default:** `Infinity`. | |
@@ -614,7 +614,7 @@ added: REPLACEME | |||
| 614 | 614 | function. | |
| 615 | 615 | * `options` {Object} Configuration options for the hook. The following | |
| 616 | 616 | properties are supported: | |
| 617 | - * `signal` {AbortSignal} Allows aborting an in-progress hook | ||
| 617 | + * `signal` {AbortSignal} Allows aborting an in-progress hook. | ||
| 618 | 618 | * `timeout` {number} A number of milliseconds the hook will fail after. | |
| 619 | 619 | If unspecified, subtests inherit this value from their parent. | |
| 620 | 620 | **Default:** `Infinity`. | |
@@ -658,7 +658,7 @@ test('top level test', (t) => { | |||
| 658 | 658 | added: REPLACEME | |
| 659 | 659 | --> | |
| 660 | 660 | ||
| 661 | - The name of the test | ||
| 661 | + The name of the test. | ||
| 662 | 662 | ||
| 663 | 663 | ### `context.runOnly(shouldRunOnlyTests)` | |
| 664 | 664 | ||
@@ -809,7 +809,7 @@ exposed as part of the API. | |||
| 809 | 809 | added: REPLACEME | |
| 810 | 810 | --> | |
| 811 | 811 | ||
| 812 | - The name of the suite | ||
| 812 | + The name of the suite. | ||
| 813 | 813 | ||
| 814 | 814 | ### `context.signal` | |
| 815 | 815 | ||
0 commit comments