Skip to content

Commit

Permalink
docs: clarify describe.skip behaviour (#12383)
Browse files Browse the repository at this point in the history
  • Loading branch information
Biki-das authored Feb 13, 2022
1 parent 29c3b24 commit 520e30d
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ test('will not be ran', () => {

Also under the alias: `xdescribe(name, fn)`

You can use `describe.skip` if you do not want to run a particular describe block:
You can use `describe.skip` if you do not want to run the tests of a particular `describe` block:

```js
describe('my beverage', () => {
Expand All @@ -416,7 +416,7 @@ describe.skip('my other beverage', () => {
});
```

Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests.
Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests. Beware that the `describe` block will still run. If you have some setup that also should be skipped, do it in a `beforeAll` or `beforeEach` block.

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

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-25.x/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ test('will not be ran', () => {

Also under the alias: `xdescribe(name, fn)`

You can use `describe.skip` if you do not want to run a particular describe block:
You can use `describe.skip` if you do not want to run the tests of a particular `describe` block:

```js
describe('my beverage', () => {
Expand All @@ -392,7 +392,7 @@ describe.skip('my other beverage', () => {
});
```

Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests.
Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests. Beware that the `describe` block will still run. If you have some setup that also should be skipped, do it in a `beforeAll` or `beforeEach` block.

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

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-26.x/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ test('will not be ran', () => {

Also under the alias: `xdescribe(name, fn)`

You can use `describe.skip` if you do not want to run a particular describe block:
You can use `describe.skip` if you do not want to run the tests of a particular `describe` block:

```js
describe('my beverage', () => {
Expand All @@ -392,7 +392,7 @@ describe.skip('my other beverage', () => {
});
```

Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests.
Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests. Beware that the `describe` block will still run. If you have some setup that also should be skipped, do it in a `beforeAll` or `beforeEach` block.

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

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-27.0/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ describe.each`

Also under the alias: `fdescribe(name, fn)`

You can use `describe.only` if you want to run only one describe block:
You can use `describe.skip` if you do not want to run the tests of a particular `describe` block:

```js
describe.only('my beverage', () => {
Expand Down Expand Up @@ -416,7 +416,7 @@ describe.skip('my other beverage', () => {
});
```

Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests.
Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests. Beware that the `describe` block will still run. If you have some setup that also should be skipped, do it in a `beforeAll` or `beforeEach` block.

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

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-27.1/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ test('will not be ran', () => {

Also under the alias: `xdescribe(name, fn)`

You can use `describe.skip` if you do not want to run a particular describe block:
You can use `describe.skip` if you do not want to run the tests of a particular `describe` block:

```js
describe('my beverage', () => {
Expand All @@ -416,7 +416,7 @@ describe.skip('my other beverage', () => {
});
```

Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests.
Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests. Beware that the `describe` block will still run. If you have some setup that also should be skipped, do it in a `beforeAll` or `beforeEach` block.

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

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-27.2/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ describe.each`

Also under the alias: `fdescribe(name, fn)`

You can use `describe.only` if you want to run only one describe block:
You can use `describe.skip` if you do not want to run the tests of a particular `describe` block:

```js
describe.only('my beverage', () => {
Expand Down Expand Up @@ -416,7 +416,7 @@ describe.skip('my other beverage', () => {
});
```

Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests.
Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests. Beware that the `describe` block will still run. If you have some setup that also should be skipped, do it in a `beforeAll` or `beforeEach` block.

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

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-27.4/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ describe.each`

Also under the alias: `fdescribe(name, fn)`

You can use `describe.only` if you want to run only one describe block:
You can use `describe.skip` if you do not want to run the tests of a particular `describe` block:

```js
describe.only('my beverage', () => {
Expand Down Expand Up @@ -416,7 +416,7 @@ describe.skip('my other beverage', () => {
});
```

Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests.
Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests. Beware that the `describe` block will still run. If you have some setup that also should be skipped, do it in a `beforeAll` or `beforeEach` block.

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

Expand Down
4 changes: 2 additions & 2 deletions website/versioned_docs/version-27.5/GlobalAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ describe.each`

Also under the alias: `fdescribe(name, fn)`

You can use `describe.only` if you want to run only one describe block:
You can use `describe.skip` if you do not want to run the tests of a particular `describe` block:

```js
describe.only('my beverage', () => {
Expand Down Expand Up @@ -416,7 +416,7 @@ describe.skip('my other beverage', () => {
});
```

Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests.
Using `describe.skip` is often a cleaner alternative to temporarily commenting out a chunk of tests. Beware that the `describe` block will still run. If you have some setup that also should be skipped, do it in a `beforeAll` or `beforeEach` block.

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

Expand Down

0 comments on commit 520e30d

Please sign in to comment.