Skip to content

Commit

Permalink
md as well
Browse files Browse the repository at this point in the history
  • Loading branch information
SimenB committed Sep 28, 2023
1 parent fd7831b commit 99ac226
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 75 deletions.
30 changes: 15 additions & 15 deletions docs/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ describe.each([
});
```

#### 2. `` describe.each`table`(name, fn, timeout) ``
#### 2. ``describe.each`table`(name, fn, timeout)``

- `table`: `Tagged Template Literal`
- First row of variable name column headings separated with `|`
Expand Down Expand Up @@ -355,7 +355,7 @@ describe('my other beverage', () => {

### `describe.only.each(table)(name, fn)`

Also under the aliases: `fdescribe.each(table)(name, fn)` and `` fdescribe.each`table`(name, fn) ``
Also under the aliases: `fdescribe.each(table)(name, fn)` and ``fdescribe.each`table`(name, fn)``

Use `describe.only.each` if you want to only run specific tests suites of data driven tests.

Expand All @@ -379,7 +379,7 @@ test('will not be run', () => {
});
```

#### `` describe.only.each`table`(name, fn) ``
#### ``describe.only.each`table`(name, fn)``

```js
describe.only.each`
Expand Down Expand Up @@ -424,7 +424,7 @@ Using `describe.skip` is often a cleaner alternative to temporarily commenting o

### `describe.skip.each(table)(name, fn)`

Also under the aliases: `xdescribe.each(table)(name, fn)` and `` xdescribe.each`table`(name, fn) ``
Also under the aliases: `xdescribe.each(table)(name, fn)` and ``xdescribe.each`table`(name, fn)``

Use `describe.skip.each` if you want to stop running a suite of data driven tests.

Expand All @@ -448,7 +448,7 @@ test('will be run', () => {
});
```

#### `` describe.skip.each`table`(name, fn) ``
#### ``describe.skip.each`table`(name, fn)``

```js
describe.skip.each`
Expand Down Expand Up @@ -566,7 +566,7 @@ test.concurrent.each([
});
```

#### 2. `` test.concurrent.each`table`(name, fn, timeout) ``
#### 2. ``test.concurrent.each`table`(name, fn, timeout)``

- `table`: `Tagged Template Literal`
- First row of variable name column headings separated with `|`
Expand Down Expand Up @@ -613,7 +613,7 @@ test('will not be run', () => {
});
```

#### `` test.only.each`table`(name, fn) ``
#### ``test.only.each`table`(name, fn)``

```js
test.concurrent.only.each`
Expand Down Expand Up @@ -654,7 +654,7 @@ test('will be run', () => {
});
```

#### `` test.concurrent.skip.each`table`(name, fn) ``
#### ``test.concurrent.skip.each`table`(name, fn)``

```js
test.concurrent.skip.each`
Expand All @@ -673,7 +673,7 @@ test('will be run', () => {

### `test.each(table)(name, fn, timeout)`

Also under the alias: `it.each(table)(name, fn)` and `` it.each`table`(name, fn) ``
Also under the alias: `it.each(table)(name, fn)` and ``it.each`table`(name, fn)``

Use `test.each` if you keep duplicating the same test with different data. `test.each` allows you to write the test once and pass data in.

Expand Down Expand Up @@ -722,7 +722,7 @@ test.each([
});
```

#### 2. `` test.each`table`(name, fn, timeout) ``
#### 2. ``test.each`table`(name, fn, timeout)``

- `table`: `Tagged Template Literal`
- First row of variable name column headings separated with `|`
Expand Down Expand Up @@ -779,7 +779,7 @@ test.failing('it is equal', () => {

### `test.failing.each(name, fn, timeout)`

Also under the alias: `it.failing.each(table)(name, fn)` and `` it.failing.each`table`(name, fn) ``
Also under the alias: `it.failing.each(table)(name, fn)` and ``it.failing.each`table`(name, fn)``

:::note

Expand Down Expand Up @@ -851,7 +851,7 @@ Usually you wouldn't check code using `test.only` into source control - you woul

### `test.only.each(table)(name, fn)`

Also under the aliases: `it.only.each(table)(name, fn)`, `fit.each(table)(name, fn)`, `` it.only.each`table`(name, fn) `` and `` fit.each`table`(name, fn) ``
Also under the aliases: `it.only.each(table)(name, fn)`, `fit.each(table)(name, fn)`, ``it.only.each`table`(name, fn)`` and ``fit.each`table`(name, fn)``

Use `test.only.each` if you want to only run specific tests with different test data.

Expand All @@ -873,7 +873,7 @@ test('will not be run', () => {
});
```

#### `` test.only.each`table`(name, fn) ``
#### ``test.only.each`table`(name, fn)``

```js
test.only.each`
Expand Down Expand Up @@ -914,7 +914,7 @@ You could comment the test out, but it's often a bit nicer to use `test.skip` be

### `test.skip.each(table)(name, fn)`

Also under the aliases: `it.skip.each(table)(name, fn)`, `xit.each(table)(name, fn)`, `xtest.each(table)(name, fn)`, `` it.skip.each`table`(name, fn) ``, `` xit.each`table`(name, fn) `` and `` xtest.each`table`(name, fn) ``
Also under the aliases: `it.skip.each(table)(name, fn)`, `xit.each(table)(name, fn)`, `xtest.each(table)(name, fn)`, ``it.skip.each`table`(name, fn)``, ``xit.each`table`(name, fn)`` and ``xtest.each`table`(name, fn)``

Use `test.skip.each` if you want to stop running a collection of data driven tests.

Expand All @@ -936,7 +936,7 @@ test('will be run', () => {
});
```

#### `` test.skip.each`table`(name, fn) ``
#### ``test.skip.each`table`(name, fn)``

```js
test.skip.each`
Expand Down
30 changes: 15 additions & 15 deletions website/versioned_docs/version-29.4/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ describe.each([
});
```

#### 2. `` describe.each`table`(name, fn, timeout) ``
#### 2. ``describe.each`table`(name, fn, timeout)``

- `table`: `Tagged Template Literal`
- First row of variable name column headings separated with `|`
Expand Down Expand Up @@ -355,7 +355,7 @@ describe('my other beverage', () => {

### `describe.only.each(table)(name, fn)`

Also under the aliases: `fdescribe.each(table)(name, fn)` and `` fdescribe.each`table`(name, fn) ``
Also under the aliases: `fdescribe.each(table)(name, fn)` and ``fdescribe.each`table`(name, fn)``

Use `describe.only.each` if you want to only run specific tests suites of data driven tests.

Expand All @@ -379,7 +379,7 @@ test('will not be run', () => {
});
```

#### `` describe.only.each`table`(name, fn) ``
#### ``describe.only.each`table`(name, fn)``

```js
describe.only.each`
Expand Down Expand Up @@ -424,7 +424,7 @@ Using `describe.skip` is often a cleaner alternative to temporarily commenting o

### `describe.skip.each(table)(name, fn)`

Also under the aliases: `xdescribe.each(table)(name, fn)` and `` xdescribe.each`table`(name, fn) ``
Also under the aliases: `xdescribe.each(table)(name, fn)` and ``xdescribe.each`table`(name, fn)``

Use `describe.skip.each` if you want to stop running a suite of data driven tests.

Expand All @@ -448,7 +448,7 @@ test('will be run', () => {
});
```

#### `` describe.skip.each`table`(name, fn) ``
#### ``describe.skip.each`table`(name, fn)``

```js
describe.skip.each`
Expand Down Expand Up @@ -566,7 +566,7 @@ test.concurrent.each([
});
```

#### 2. `` test.concurrent.each`table`(name, fn, timeout) ``
#### 2. ``test.concurrent.each`table`(name, fn, timeout)``

- `table`: `Tagged Template Literal`
- First row of variable name column headings separated with `|`
Expand Down Expand Up @@ -613,7 +613,7 @@ test('will not be run', () => {
});
```

#### `` test.only.each`table`(name, fn) ``
#### ``test.only.each`table`(name, fn)``

```js
test.concurrent.only.each`
Expand Down Expand Up @@ -654,7 +654,7 @@ test('will be run', () => {
});
```

#### `` test.concurrent.skip.each`table`(name, fn) ``
#### ``test.concurrent.skip.each`table`(name, fn)``

```js
test.concurrent.skip.each`
Expand All @@ -673,7 +673,7 @@ test('will be run', () => {

### `test.each(table)(name, fn, timeout)`

Also under the alias: `it.each(table)(name, fn)` and `` it.each`table`(name, fn) ``
Also under the alias: `it.each(table)(name, fn)` and ``it.each`table`(name, fn)``

Use `test.each` if you keep duplicating the same test with different data. `test.each` allows you to write the test once and pass data in.

Expand Down Expand Up @@ -722,7 +722,7 @@ test.each([
});
```

#### 2. `` test.each`table`(name, fn, timeout) ``
#### 2. ``test.each`table`(name, fn, timeout)``

- `table`: `Tagged Template Literal`
- First row of variable name column headings separated with `|`
Expand Down Expand Up @@ -779,7 +779,7 @@ test.failing('it is equal', () => {

### `test.failing.each(name, fn, timeout)`

Also under the alias: `it.failing.each(table)(name, fn)` and `` it.failing.each`table`(name, fn) ``
Also under the alias: `it.failing.each(table)(name, fn)` and ``it.failing.each`table`(name, fn)``

:::note

Expand Down Expand Up @@ -851,7 +851,7 @@ Usually you wouldn't check code using `test.only` into source control - you woul

### `test.only.each(table)(name, fn)`

Also under the aliases: `it.only.each(table)(name, fn)`, `fit.each(table)(name, fn)`, `` it.only.each`table`(name, fn) `` and `` fit.each`table`(name, fn) ``
Also under the aliases: `it.only.each(table)(name, fn)`, `fit.each(table)(name, fn)`, ``it.only.each`table`(name, fn)`` and ``fit.each`table`(name, fn)``

Use `test.only.each` if you want to only run specific tests with different test data.

Expand All @@ -873,7 +873,7 @@ test('will not be run', () => {
});
```

#### `` test.only.each`table`(name, fn) ``
#### ``test.only.each`table`(name, fn)``

```js
test.only.each`
Expand Down Expand Up @@ -914,7 +914,7 @@ You could comment the test out, but it's often a bit nicer to use `test.skip` be

### `test.skip.each(table)(name, fn)`

Also under the aliases: `it.skip.each(table)(name, fn)`, `xit.each(table)(name, fn)`, `xtest.each(table)(name, fn)`, `` it.skip.each`table`(name, fn) ``, `` xit.each`table`(name, fn) `` and `` xtest.each`table`(name, fn) ``
Also under the aliases: `it.skip.each(table)(name, fn)`, `xit.each(table)(name, fn)`, `xtest.each(table)(name, fn)`, ``it.skip.each`table`(name, fn)``, ``xit.each`table`(name, fn)`` and ``xtest.each`table`(name, fn)``

Use `test.skip.each` if you want to stop running a collection of data driven tests.

Expand All @@ -936,7 +936,7 @@ test('will be run', () => {
});
```

#### `` test.skip.each`table`(name, fn) ``
#### ``test.skip.each`table`(name, fn)``

```js
test.skip.each`
Expand Down
Loading

0 comments on commit 99ac226

Please sign in to comment.