Help command must use Stdout instead of Stderr #303
Conversation
| // Can be defined by user by overriding UsageFunc | ||
| func (c *Command) Usage() error { | ||
| c.mergePersistentFlags() | ||
| err := tmpl(c.getOutOrStderr(), c.UsageTemplate(), c) |
There was a problem hiding this comment.
I think this is wrong. It's not using UsageFunc() so if someone has set SetUsageFunc() it wont print the correct usage.
There was a problem hiding this comment.
@dnephin Unless I'm missing something, it actually works the other way - UsageFunc() uses this one, and if another func were provided through SetUsageFunc, it's going to be used and this one will be ignored.
I mostly did this to improve code clarity and conciseness: UsageFunc() calls Usage() the same way HelpFunc() were already calling Help().
There was a problem hiding this comment.
The problem is that Usage() is public, so anyone calling Usage() will not get the same result. If Usage() were usage() that would be fine.
There was a problem hiding this comment.
I'd be ok with having usage() and help(), or even move the content of these funcs to the body of their respective UsageFunc and HelpFunc. Our exposed stuff for getting the usage are either UsageFunc or UsageString (which should correctly call UsageFunc to return the proper string), and having these ones only lead to confusion in my opinion. @dnephin WDYT?
|
UP |
Help when called from
-hor thehelpcommand must print to Stdout. Right now it only happens in the root cmd, any subcommand (e.g.cmd subcmd -h) prints to Stderr.Other minor code reorg.