Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork847
Update help output to reflect required args.#946
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Update help output to reflect required args.#946
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Proposed fix for Issue#945Help output messages should now properly reflect whether args are required.I didn't find any Options which seemed to take optional arguments; they all look like they require args OR require zero args.Another pair of eyes would be great to double-check!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Cool, the additional notation looks right.
There are a few documentation files which repeat this info, if you can find them, perhaps in man/ or doc/ or someplace, hunt for it - if you aren't able to get them updated, just say so, and we'll merge this change as a step on the way.
This will change the --help output for the user trying the tool interactively. The man page is for a smaller, discerning audience, who read that stuff. (Same content, hehe.)
Let me know if you are up to looking for how to regenerate or edit those files!
Sure thing! I'll do some digging around and get those updated as well. |
Okay! Not sure how I missed the man/ directory the first time around haha. The four man files in that directory have now been updated. |
| . | ||
| .P | ||
| Define your own set of sections which overrides all default sections\. | ||
| . | ||
| .P | ||
| \-\-add\-sections[HASH, STRING] | ||
| \-\-add\-sections HASH, STRING |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Maybe we should investigate this. Me, reading it, can't from the example figure out real quick what I can write here. Is Hash defined anywhere? How do I tell the CLI to enter a hash here? Can I do that in the CLI version?
I understand that this was not introduced by your amazing changes, but perhaps we need to capture this in an Issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks for fixing this!
It improves the quality of the documentation a lot!
@spark-c Thank you! |
Uh oh!
There was an error while loading.Please reload this page.
This PRfixes#945
Help output messages should now properly reflect whether args are required.
I didn't find any Options which seemed to take optional arguments; they all look like they require args OR require zero args.
Another pair of eyes would be great to double-check!