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

docs: Expand --debug option description in the CLI documentation #15308

Merged
merged 2 commits into from Nov 16, 2021
Merged

docs: Expand --debug option description in the CLI documentation #15308

merged 2 commits into from Nov 16, 2021

Conversation

darkred
Copy link
Contributor

@darkred darkred commented Nov 12, 2021

Prerequisites checklist

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

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

What changes did you make? (Give an overview)

This is a follow-up of a short discussion in Discord

I expand the --debug flag description, in order to clarify that:

  • its purpose is to set ESLint to run on a file/file list e.g. eslint --debug test.js or eslint test.js --debug (equivalent)
  • there's no meaning in using it on its own, eslint --debug, because running ESLint with no arguments is generally not valid.

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

No

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Nov 12, 2021
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 12, 2021

CLA Signed

The committers are authorized under a signed CLA.

@darkred darkred marked this pull request as draft November 12, 2021 23:08
@darkred darkred marked this pull request as ready for review November 13, 2021 15:42
@nzakas nzakas added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Nov 16, 2021
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks

@nzakas nzakas merged commit 6b85426 into eslint:main Nov 16, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 16, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label May 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants