Skip to content

Commit

Permalink
docs: replace warning with warn
Browse files Browse the repository at this point in the history
  • Loading branch information
Drapegnik committed Oct 13, 2018
1 parent 47f624a commit abd0f9b
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/rules/max-top-level-suites.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ If you want to change the suite limit to, for instance, 2 suites per file:

```js
rules: {
"mocha/max-top-level-suites": ["warning", {limit: 2}]
"mocha/max-top-level-suites": ["warn", {limit: 2}]
},
```
2 changes: 1 addition & 1 deletion docs/rules/no-synchronous-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You can change the acceptable asynchronous test methods to only allow a combinat
```js
rules: {
"mocha/no-synchronous-tests": ["warning", {allowed: ['async', 'callback', 'promise']}]
"mocha/no-synchronous-tests": ["warn", {allowed: ['async', 'callback', 'promise']}]
},
```
Expand Down
6 changes: 3 additions & 3 deletions docs/rules/valid-suite-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ Example of a custom rule configuration:

```js
rules: {
"mocha/valid-suite-description": ["warning", "^[A-Z]"]
"mocha/valid-suite-description": ["warn", "^[A-Z]"]
},
```

where:

* `warning` is a rule error level (see [Configuring Rules](http://eslint.org/docs/user-guide/configuring#configuring-rules))
* `warn` is a rule error level (see [Configuring Rules](http://eslint.org/docs/user-guide/configuring#configuring-rules))
* `^[A-Z]` is a custom regular expression pattern to match suite names against; `^[A-Z]` enforces a suite name to start with an upper-case letter

The following patterns are considered warnings (with the example rule configuration posted above):
Expand Down Expand Up @@ -46,6 +46,6 @@ There is also possible to configure a custom list of suite names via the second

```js
rules: {
"mocha/valid-suite-description": ["warning", "^[A-Z]", ["describe", "context", "suite", "mysuitename"]]
"mocha/valid-suite-description": ["warn", "^[A-Z]", ["describe", "context", "suite", "mysuitename"]]
},
```
4 changes: 2 additions & 2 deletions docs/rules/valid-test-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ Example of a custom rule configuration:

```js
rules: {
"mocha/valid-test-description": ["warning", "mypattern$", ["it", "specify", "test", "mytestname"]]
"mocha/valid-test-description": ["warn", "mypattern$", ["it", "specify", "test", "mytestname"]]
},
```

where:

* `warning` is a rule error level (see [Configuring Rules](http://eslint.org/docs/user-guide/configuring#configuring-rules))
* `warn` is a rule error level (see [Configuring Rules](http://eslint.org/docs/user-guide/configuring#configuring-rules))
* `mypattern$` is a custom regular expression pattern to match test names against
* `["it", "specify", "test", "mytestname"]` is an array of custom test names

Expand Down

0 comments on commit abd0f9b

Please sign in to comment.