Documentation of command-line options is far too brief #236
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
Hacktoberfest
Milestone
📃 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:
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.
The text was updated successfully, but these errors were encountered: