Skip to content

Commit 1401584

Browse files
committed
fix(doc): copyedit README.md
PR-URL: nodejs/node#44061 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Feng Yu <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> (cherry picked from commit a8bc202d855cc7d14895db38a2ac09d1f873e803)
1 parent 2f02171 commit 1401584

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Running tests can also be done using `describe` to declare a suite
159159
and `it` to declare a test.
160160
A suite is used to organize and group related tests together.
161161
`it` is an alias for `test`, except there is no test context passed,
162-
since nesting is done using suites, as demonstrated in this example
162+
since nesting is done using suites.
163163

164164
```js
165165
describe('A thing', () => {
@@ -179,7 +179,7 @@ describe('A thing', () => {
179179
});
180180
```
181181

182-
`describe` and `it` are imported from the `test` module
182+
`describe` and `it` are imported from the `test` module.
183183

184184
```mjs
185185
import { describe, it } from 'test';
@@ -392,7 +392,7 @@ thus prevent the scheduled cancellation.
392392
results. **Default:** The `name` property of `fn`, or `'<anonymous>'` if `fn`
393393
does not have a name.
394394
* `options` {Object} Configuration options for the suite.
395-
supports the same options as `test([name][, options][, fn])`
395+
supports the same options as `test([name][, options][, fn])`.
396396
* `fn` {Function|AsyncFunction} The function under suite
397397
declaring all subtests and subsuites.
398398
The first argument to this function is a [`SuiteContext`][] object.
@@ -403,7 +403,7 @@ The `describe()` function imported from the `test` module. Each
403403
invocation of this function results in the creation of a Subtest
404404
and a test point in the TAP output.
405405
After invocation of top level `describe` functions,
406-
all top level tests and suites will execute
406+
all top level tests and suites will execute.
407407

408408
## `describe.skip([name][, options][, fn])`
409409

@@ -448,7 +448,7 @@ same as [`it([name], { todo: true }[, fn])`][it options].
448448
function.
449449
* `options` {Object} Configuration options for the hook. The following
450450
properties are supported:
451-
* `signal` {AbortSignal} Allows aborting an in-progress hook
451+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
452452
* `timeout` {number} A number of milliseconds the hook will fail after.
453453
If unspecified, subtests inherit this value from their parent.
454454
**Default:** `Infinity`.
@@ -472,7 +472,7 @@ describe('tests', async () => {
472472
function.
473473
* `options` {Object} Configuration options for the hook. The following
474474
properties are supported:
475-
* `signal` {AbortSignal} Allows aborting an in-progress hook
475+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
476476
* `timeout` {number} A number of milliseconds the hook will fail after.
477477
If unspecified, subtests inherit this value from their parent.
478478
**Default:** `Infinity`.
@@ -496,7 +496,7 @@ describe('tests', async () => {
496496
function.
497497
* `options` {Object} Configuration options for the hook. The following
498498
properties are supported:
499-
* `signal` {AbortSignal} Allows aborting an in-progress hook
499+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
500500
* `timeout` {number} A number of milliseconds the hook will fail after.
501501
If unspecified, subtests inherit this value from their parent.
502502
**Default:** `Infinity`.
@@ -521,7 +521,7 @@ describe('tests', async () => {
521521
function.
522522
* `options` {Object} Configuration options for the hook. The following
523523
properties are supported:
524-
* `signal` {AbortSignal} Allows aborting an in-progress hook
524+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
525525
* `timeout` {number} A number of milliseconds the hook will fail after.
526526
If unspecified, subtests inherit this value from their parent.
527527
**Default:** `Infinity`.
@@ -552,7 +552,7 @@ exposed as part of the API.
552552
function.
553553
* `options` {Object} Configuration options for the hook. The following
554554
properties are supported:
555-
* `signal` {AbortSignal} Allows aborting an in-progress hook
555+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
556556
* `timeout` {number} A number of milliseconds the hook will fail after.
557557
If unspecified, subtests inherit this value from their parent.
558558
**Default:** `Infinity`.
@@ -580,7 +580,7 @@ test('top level test', async (t) => {
580580
function.
581581
* `options` {Object} Configuration options for the hook. The following
582582
properties are supported:
583-
* `signal` {AbortSignal} Allows aborting an in-progress hook
583+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
584584
* `timeout` {number} A number of milliseconds the hook will fail after.
585585
If unspecified, subtests inherit this value from their parent.
586586
**Default:** `Infinity`.
@@ -610,7 +610,7 @@ not return a value.
610610

611611
`context.name`
612612

613-
The name of the test
613+
The name of the test.
614614

615615
### `context.runOnly(shouldRunOnlyTests)`
616616

@@ -688,7 +688,7 @@ exposed as part of the API.
688688

689689
### `context.name`
690690

691-
The name of the suite
691+
The name of the suite.
692692

693693
### `context.signal`
694694

0 commit comments

Comments
 (0)