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

Minor documentation tweaks #217

Merged
merged 1 commit into from
Oct 28, 2019
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: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,3 @@ See [Configuring Eslint](http://eslint.org/docs/user-guide/configuring) on [esli
## Rules documentation

The documentation of the rules [can be found here](docs/rules).

## When Not To Use It

If you are not using mocha you should not use this plugin.
2 changes: 1 addition & 1 deletion docs/rules/no-async-describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,5 @@ describe('my suite', mySuite);

## When Not To Use It

- If you use another library which exposes a similar API as mocha (e.g. `describe.only`), you should turn this rule off because it would raise warnings.
- If you use another library which exposes a similar API as mocha, you should turn this rule off because it would raise warnings.
- In environments that have not yet adopted ES6 language features (ES3/5).
1 change: 0 additions & 1 deletion docs/rules/prefer-arrow-callback.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,6 @@ someArray.map(function(itm) { return this.doSomething(itm); }, someObject);
## When Not To Use It

- In environments that have not yet adopted ES6 language features (ES3/5).

- In ES6+ environments that allow the use of function expressions when describing callbacks or function arguments.

## Further Reading
Expand Down