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.

Sign up for GitHub

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

Jump to bottom

docs(prefer-lowercase-title): Fix rule name in examples #968

Merged
merged 1 commit into from Oct 26, 2021
Merged

docs(prefer-lowercase-title): Fix rule name in examples #968

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/rules/prefer-lowercase-title.md
View file
Open in desktop
Expand Up @@ -26,7 +26,7 @@ it('adds 1 + 2 to equal 3', () => {

```json
{
"jest/prefer-lowercase-name": [
"jest/prefer-lowercase-title": [
"error",
{
"ignore": ["describe", "test"]
Expand All @@ -50,23 +50,23 @@ By default, none of these options are enabled (the equivalent of
Example of **correct** code for the `{ "ignore": ["describe"] }` option:

```js
/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["describe"] }] */
/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["describe"] }] */

describe('Uppercase description');
```

Example of **correct** code for the `{ "ignore": ["test"] }` option:

```js
/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["test"] }] */
/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["test"] }] */

test('Uppercase description');
```

Example of **correct** code for the `{ "ignore": ["it"] }` option:

```js
/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["it"] }] */
/* eslint jest/prefer-lowercase-title: ["error", { "ignore": ["it"] }] */

it('Uppercase description');
```
Expand All @@ -82,7 +82,7 @@ By default, nothing is allowed (the equivalent of `{ "allowedPrefixes": [] }`).
Example of **correct** code for the `{ "allowedPrefixes": ["GET"] }` option:

```js
/* eslint jest/prefer-lowercase-name: ["error", { "allowedPrefixes": ["GET"] }] */
/* eslint jest/prefer-lowercase-title: ["error", { "allowedPrefixes": ["GET"] }] */

describe('GET /live');
```
Expand All @@ -95,7 +95,7 @@ title starting with an upper-case letter.
Example of **correct** code for the `{ "ignoreTopLevelDescribe": true }` option:

```js
/* eslint jest/prefer-lowercase-name: ["error", { "ignoreTopLevelDescribe": true }] */
/* eslint jest/prefer-lowercase-title: ["error", { "ignoreTopLevelDescribe": true }] */
describe('MyClass', () => {
describe('#myMethod', () => {
it('does things', () => {
Expand Down