Skip to content

Commit cd64813

Browse files
aduh95danielleadams
authored andcommitted
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 45f580f commit cd64813

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/api/test.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Running tests can also be done using `describe` to declare a suite
154154
and `it` to declare a test.
155155
A suite is used to organize and group related tests together.
156156
`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.
158158

159159
```js
160160
describe('A thing', () => {
@@ -174,7 +174,7 @@ describe('A thing', () => {
174174
});
175175
```
176176

177-
`describe` and `it` are imported from the `node:test` module
177+
`describe` and `it` are imported from the `node:test` module.
178178

179179
```mjs
180180
import { describe, it } from 'node:test';
@@ -398,7 +398,7 @@ thus prevent the scheduled cancellation.
398398
results. **Default:** The `name` property of `fn`, or `'<anonymous>'` if `fn`
399399
does not have a name.
400400
* `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])`.
402402
* `fn` {Function|AsyncFunction} The function under suite
403403
declaring all subtests and subsuites.
404404
The first argument to this function is a [`SuiteContext`][] object.
@@ -409,7 +409,7 @@ The `describe()` function imported from the `node:test` module. Each
409409
invocation of this function results in the creation of a Subtest
410410
and a test point in the TAP output.
411411
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.
413413

414414
## `describe.skip([name][, options][, fn])`
415415

@@ -458,7 +458,7 @@ added: REPLACEME
458458
function.
459459
* `options` {Object} Configuration options for the hook. The following
460460
properties are supported:
461-
* `signal` {AbortSignal} Allows aborting an in-progress hook
461+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
462462
* `timeout` {number} A number of milliseconds the hook will fail after.
463463
If unspecified, subtests inherit this value from their parent.
464464
**Default:** `Infinity`.
@@ -486,7 +486,7 @@ added: REPLACEME
486486
function.
487487
* `options` {Object} Configuration options for the hook. The following
488488
properties are supported:
489-
* `signal` {AbortSignal} Allows aborting an in-progress hook
489+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
490490
* `timeout` {number} A number of milliseconds the hook will fail after.
491491
If unspecified, subtests inherit this value from their parent.
492492
**Default:** `Infinity`.
@@ -514,7 +514,7 @@ added: REPLACEME
514514
function.
515515
* `options` {Object} Configuration options for the hook. The following
516516
properties are supported:
517-
* `signal` {AbortSignal} Allows aborting an in-progress hook
517+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
518518
* `timeout` {number} A number of milliseconds the hook will fail after.
519519
If unspecified, subtests inherit this value from their parent.
520520
**Default:** `Infinity`.
@@ -543,7 +543,7 @@ added: REPLACEME
543543
function.
544544
* `options` {Object} Configuration options for the hook. The following
545545
properties are supported:
546-
* `signal` {AbortSignal} Allows aborting an in-progress hook
546+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
547547
* `timeout` {number} A number of milliseconds the hook will fail after.
548548
If unspecified, subtests inherit this value from their parent.
549549
**Default:** `Infinity`.
@@ -582,7 +582,7 @@ added: REPLACEME
582582
function.
583583
* `options` {Object} Configuration options for the hook. The following
584584
properties are supported:
585-
* `signal` {AbortSignal} Allows aborting an in-progress hook
585+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
586586
* `timeout` {number} A number of milliseconds the hook will fail after.
587587
If unspecified, subtests inherit this value from their parent.
588588
**Default:** `Infinity`.
@@ -614,7 +614,7 @@ added: REPLACEME
614614
function.
615615
* `options` {Object} Configuration options for the hook. The following
616616
properties are supported:
617-
* `signal` {AbortSignal} Allows aborting an in-progress hook
617+
* `signal` {AbortSignal} Allows aborting an in-progress hook.
618618
* `timeout` {number} A number of milliseconds the hook will fail after.
619619
If unspecified, subtests inherit this value from their parent.
620620
**Default:** `Infinity`.
@@ -658,7 +658,7 @@ test('top level test', (t) => {
658658
added: REPLACEME
659659
-->
660660

661-
The name of the test
661+
The name of the test.
662662

663663
### `context.runOnly(shouldRunOnlyTests)`
664664

@@ -809,7 +809,7 @@ exposed as part of the API.
809809
added: REPLACEME
810810
-->
811811

812-
The name of the suite
812+
The name of the suite.
813813

814814
### `context.signal`
815815

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy