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.

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

doc: remove unnecessary leading commas #44854

Merged
merged 1 commit into from
Oct 4, 2022
Merged
Changes from all commits
Commits
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
doc: remove unnecessary leading commas
There are several locations in the test_runner API docs where
the optional first argument to a function was written with a
leading comma. Since these are first arguments, the commas
can be removed.
cjihrig authored Oct 1, 2022
commit b6521532f29da4eb20864b5dde02cdaedbb52bcf
12 changes: 6 additions & 6 deletions doc/api/test.md
Original file line number Diff line number Diff line change
@@ -484,7 +484,7 @@ same as [`it([name], { skip: true }[, fn])`][it options].
Shorthand for marking a test as `TODO`,
same as [`it([name], { todo: true }[, fn])`][it options].

## `before([, fn][, options])`
## `before([fn][, options])`

<!-- YAML
added: v18.8.0
@@ -512,7 +512,7 @@ describe('tests', async () => {
});
```

## `after([, fn][, options])`
## `after([fn][, options])`

<!-- YAML
added: v18.8.0
@@ -540,7 +540,7 @@ describe('tests', async () => {
});
```

## `beforeEach([, fn][, options])`
## `beforeEach([fn][, options])`

<!-- YAML
added: v18.8.0
@@ -569,7 +569,7 @@ describe('tests', async () => {
});
```

## `afterEach([, fn][, options])`
## `afterEach([fn][, options])`

<!-- YAML
added: v18.8.0
@@ -651,7 +651,7 @@ An instance of `TestContext` is passed to each test function in order to
interact with the test runner. However, the `TestContext` constructor is not
exposed as part of the API.

### `context.beforeEach([, fn][, options])`
### `context.beforeEach([fn][, options])`

<!-- YAML
added: v18.8.0
@@ -683,7 +683,7 @@ test('top level test', async (t) => {
});
```

### `context.afterEach([, fn][, options])`
### `context.afterEach([fn][, options])`

<!-- YAML
added: v18.8.0