Update help output to reflect required args. #946
Conversation
Proposed fix for Issue#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!
There was a problem hiding this comment.
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.
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.
|
@spark-c Thank you! |
This PR fixes #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!