diff --git a/doc/api/test.md b/doc/api/test.md index b02586082d0866..6465a4e070d600 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -345,7 +345,7 @@ changes: * `only` {boolean} If truthy, and the test context is configured to run `only` tests, then this test will be run. Otherwise, the test is skipped. **Default:** `false`. - * `signal` {AbortSignal} Allows aborting an in-progress test + * `signal` {AbortSignal} Allows aborting an in-progress test. * `skip` {boolean|string} If truthy, the test is skipped. If a string is provided, that string is displayed in the test results as the reason for skipping the test. **Default:** `false`. @@ -504,7 +504,8 @@ test('top level test', (t) => { added: v16.17.0 --> -* Can be used to abort test subtasks when the test has been aborted. +* {AbortSignal} Can be used to abort test subtasks when the test has been + aborted. ```js test('top level test', async (t) => { @@ -575,7 +576,7 @@ changes: * `only` {boolean} If truthy, and the test context is configured to run `only` tests, then this test will be run. Otherwise, the test is skipped. **Default:** `false`. - * `signal` {AbortSignal} Allows aborting an in-progress test + * `signal` {AbortSignal} Allows aborting an in-progress test. * `skip` {boolean|string} If truthy, the test is skipped. If a string is provided, that string is displayed in the test results as the reason for skipping the test. **Default:** `false`. @@ -622,7 +623,8 @@ exposed as part of the API. added: v16.17.0 --> -* Can be used to abort test subtasks when the test has been aborted. +* {AbortSignal} Can be used to abort test subtasks when the test has been + aborted. [TAP]: https://testanything.org/ [`--test-only`]: cli.md#--test-only