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

Breaking: description in directive comments (refs eslint/rfcs#33) #12699

Merged
merged 10 commits into from
Jan 17, 2020
Merged

Breaking: description in directive comments (refs eslint/rfcs#33) #12699

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f466894
Breaking: description in directive comments (refs eslint/rfcs#33)
mysticatea Dec 22, 2019
ed9ca64
Update docs/user-guide/configuring.md
mysticatea Dec 24, 2019
4246f02
Update docs/user-guide/configuring.md
mysticatea Dec 24, 2019
eb32ec7
Update docs/user-guide/configuring.md
mysticatea Dec 24, 2019
7808a32
Update docs/user-guide/configuring.md
mysticatea Dec 24, 2019
057befe
Update docs/user-guide/configuring.md
mysticatea Dec 24, 2019
b6d61d6
Update tests/lib/linter/linter.js
mysticatea Dec 24, 2019
01548bf
Update docs/user-guide/configuring.md
mysticatea Jan 7, 2020
df85699
update configuring.md
mysticatea Jan 7, 2020
34bde43
Merge remote-tracking branch 'origin/master' into rfc33
mysticatea Jan 7, 2020
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
Prev Previous commit
Next Next commit
Update docs/user-guide/configuring.md 
Co-Authored-By: Kai Cataldo <kai@kaicataldo.com>
  • Loading branch information
@mysticatea @kaicataldo
mysticatea and kaicataldo authored Dec 24, 2019
commit 057befe355840425beeffb005153569040978705
2 changes: 1 addition & 1 deletion docs/user-guide/configuring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ foo(); // eslint-disable-line example/rule-name
foo(); /* eslint-disable-line example/rule-name */
```

If the part preceded by `--` exists in the inline comments, ESLint ignores the part. The `--` can be longer than 2. For examples:
Configuration comments can include descriptions to explain why the comment is necessary. The description must occur after the configuration is separated from the comment by at two or more consecutive `-` characters. For example:
mysticatea marked this conversation as resolved.
Show resolved Hide resolved

```js
// eslint-disable-next-line no-console -- Here's a description about why this configuration is necessary.
Expand Down