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

chore: doc(GlobalApi):- Clarified describe.skip behaviour #12383

Merged
merged 1 commit into from
Feb 13, 2022
Merged
Show file tree
Hide file tree
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
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