Skip to content

Commit

Permalink
doc: remove unnecessary leading commas
Browse files Browse the repository at this point in the history
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.

PR-URL: #44854
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
cjihrig authored and danielleadams committed Oct 5, 2022
1 parent 781ad96 commit 780144c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,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
Expand Down Expand Up @@ -508,7 +508,7 @@ describe('tests', async () => {
});
```

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

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

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

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

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

<!-- YAML
added: v18.8.0
Expand Down Expand Up @@ -645,7 +645,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
Expand Down Expand Up @@ -677,7 +677,7 @@ test('top level test', async (t) => {
});
```

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

<!-- YAML
added: v18.8.0
Expand Down

0 comments on commit 780144c

Please sign in to comment.