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 inconsistencies in CLI docs #6627

Closed
platinumazure opened this issue Jul 8, 2016 · 3 comments
Closed

Minor inconsistencies in CLI docs #6627

platinumazure opened this issue Jul 8, 2016 · 3 comments
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 bug ESLint is working incorrectly documentation Relates to ESLint's documentation

Comments

@platinumazure
Copy link
Member

(Skipping bug report template since this is docs only)

I was reading through the CLI docs and saw some minor inconsistencies between -h and -v (which I would expect to be pretty similar and simple):

  • Both options mention that other CLI options are ignored. One option says "flags", the other "options". I like "options" better because to me "flags" represent booleans, but I can do either.
  • Only -v has an example. A lot of other options have examples even for ridiculously trivial case, so I can add one for -h.

If accepted, I can knock this out pretty quickly.

@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Jul 8, 2016
@platinumazure platinumazure added documentation Relates to ESLint's documentation cli Relates to ESLint's command-line interface evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion chore This change is not user-facing and removed triage An ESLint team member will look at this issue soon cli Relates to ESLint's command-line interface labels Jul 8, 2016
@gyandeeps
Copy link
Member

Example for -h will be huge since it prints all the cli options. Personally I dont think we need an example for that.

@platinumazure
Copy link
Member Author

Ah, I meant just the command line, similar to what is used for -v.

I'm also okay with removing the example for -v. It's the inconsistency
between the two that bothers me.
On Jul 8, 2016 9:15 AM, "Gyandeep Singh" notifications@github.com wrote:

Example for -h will be huge since it prints all the cli options.
Personally I dont think we need an example for that.


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#6627 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AARWeoItm-XjkiPbXT2pPoQJgtTbc9Dpks5qTltvgaJpZM4JHtVa
.

@nzakas nzakas added bug ESLint is working incorrectly accepted There is consensus among the team that this change meets the criteria for inclusion and removed chore This change is not user-facing evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Jul 9, 2016
@nzakas
Copy link
Member

nzakas commented Jul 9, 2016

Agree that example for -h is overkill (especially since the output is already included at the top). Feel free to adjust the language to be more consistent.

platinumazure added a commit to platinumazure/eslint that referenced this issue Jul 9, 2016
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
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 bug ESLint is working incorrectly documentation Relates to ESLint's documentation
Projects
None yet
Development

No branches or pull requests

4 participants