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

Documentation of command-line options is far too brief #236

Closed
tarkatronic opened this issue Oct 22, 2021 · 0 comments · Fixed by #288
Closed

Documentation of command-line options is far too brief #236

tarkatronic opened this issue Oct 22, 2021 · 0 comments · Fixed by #288
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest
Milestone

Comments

@tarkatronic
Copy link
Contributor

📃 Summary

A lot of the documentation we have for command-line options is far too brief, and really tells the user nothing about what it does. For example:

  --compact / --no-compact        Enable reduced output.  [default: False]

What... does that actually mean? It ends up outputting 3 or 4 columns, which is very much "reduced" and "compact". But what do those columns mean?

Expected documentation

Each command line option should be thoroughly reviewed, and make sure the available help gives a minimum amount of information to be helpful.

In addition, our current "Usage" page may need to change from being auto-generated, to being manual. The auto-generation has been very useful/helpful up until now, but we may be getting beyond the point where it provides everything we need.

@tarkatronic tarkatronic added documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest labels Oct 22, 2021
@tarkatronic tarkatronic added this to the Version 3.0 milestone Oct 26, 2021
@tarkatronic tarkatronic linked a pull request Dec 1, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant