OptionKit icon indicating copy to clipboard operation
OptionKit copied to clipboard

Help description never displayed

Open mac-cain13 opened this issue 10 years ago • 1 comments

The docs say the given helpDescription with an Option will be displayed when the --help option is triggered, but it is never displayed. Quite useless this way. ;)

I think there should be a "usage" output like what helpStringForCommandName outputs now, but I think there should also be a variant that outputs real help that explains what each option does.

mac-cain13 avatar Sep 27 '15 09:09 mac-cain13

+1

The Option struct already accepts the helpDescription parameter and dutifully stores it, but the rest of the code doesn't actually use it when generating the help text or error messages. This would be a very useful feature to have.

stupergenius avatar Nov 17 '15 23:11 stupergenius