Mentioning eslint-disable-line

[fhightower]

I expected to find eslint-disable-line mentioned on this page and I noticed that eslint-disable-line is never explicitly documented from what I could find (although it's noted in numerous examples). I think it would be helpful to mention it on this page which discusses how to ignore code. Thanks!

Prerequisites checklist

• I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

[linux-foundation-easycla]

• ❌ - login: @fhightower / name: Floyd . The commit (d824964) is not authorized under a signed CLA. Please click here to be authorized. For further assistance with EasyCLA, please submit a support request ticket.

[netlify]

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	d824964
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/63b898146da058000a743759
😎 Deploy Preview	https://deploy-preview-16756--docs-eslint.netlify.app/user-guide/configuring/ignoring-code
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[eslint-github-bot]

Hi @fhightower!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

• The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
• There should be a space following the initial tag and colon, for example 'feat: Message'.
• The first letter of the tag should be in lowercase

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

[bmish]

It looks like the "ignoring code" doc is more about ignoring files than actual lines of code?

I agree that from the name "ignoring code" one might expect to be able to find information about ignoring lines of code.

Maybe adding small section at the bottom of the doc that links to Using Configuration Comments would be worthwhile? For increasing discoverability while not duplicating content from the other doc.

Wherever the source of truth for these disable directives ends up living, it seems like it would be helpful to a have a bullet-point list of all the types of disable directive comments. I see such a list in yet another doc's sections called Inline Configuration Comments. In my mind, there would be one section about all this that every other page can link to.

[mdjermanovic]

Yes, this document is only about specifying files that ESLint should just skip. eslint-disable-line is a different concept.

I agree with @bmish that "ignoring code" is a confusing name for this, and I think we should change the title and navigation item when implementing #16720. @bpmutter what do you think?

[bpmutter]

Yes, this document is only about specifying files that ESLint should just skip. eslint-disable-line is a different concept.

I agree with @bmish that "ignoring code" is a confusing name for this, and I think we should change the title and navigation item when implementing #16720. @bpmutter what do you think?

i agree that the current name is confusing, and it would make more sense to rename the page 'Ignore Files' as part of #16720. will do that. (doesn't hurt that it's a very small change, as well)

[snitin315]

Recently the title was changed to ignore files in #16760 which should avoid such confusion in the future.

@fhightower Thanks for bringing it up, closing this PR as resolved.