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.

Sign up for GitHub

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

Jump to bottom

doc: fix typos in test.md #43997

Merged
merged 2 commits into from
Jul 26, 2022
Merged

doc: fix typos in test.md #43997

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a577ee0
doc: fix typos in `test.md`
aduh95 Jul 26, 2022
3edcd53
lint
aduh95 Jul 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions doc/api/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -504,7 +504,8 @@ test('top level test', (t) => {
added: REPLACEME
-->

* <AbortSignal> 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) => {
Expand Down Expand Up @@ -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`.
Expand Down Expand Up @@ -622,7 +623,8 @@ exposed as part of the API.
added: REPLACEME
-->

* <AbortSignal> 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
Expand Down