Skip to content
This repository has been archived by the owner on Nov 18, 2020. It is now read-only.

Make --help, help usage help messages consistent #437

Merged
merged 1 commit into from
Jun 29, 2020

Conversation

michaelklishin
Copy link
Member

  • help printed an "Error:" at the top for no reason
  • help [command] with a non-existent command did not offer a suggestion
    like an attempt to invoke a non-existent command would
  • Exit codes were not consistent
  • help --list-commands had line break issues

With this change,

  • help is consistent with --help
  • help [command] is consistent with [command] --help
  • If a command is not found, either during the execution flow
    or help [commnad], we consistently attempt a Jaro distance suggestion
  • Successful or effectively successful exits from the help command do not produce any error messages at the top

 * `help` printed an "Error:" at the top for no reason
 * `help [command]` with a non-existent command did not offer a suggestion
   like an attempt to invoke a non-existent command would
 * Exit codes were not consistent
 * `help --list-commands` had line break issues

With this change,

  * `help` is consistent with --help
  * `help [command]` is consistent with `[command] --help`
  * If a command is not found, either during the execution flow
    or `help [commnad]`, we consistently attempt a Jaro distance suggestion
  * Successful or effectively successful exits from the `help`
    command do not produce any error messages at the top
@michaelklishin michaelklishin added this to the 3.8.6 milestone Jun 29, 2020
@michaelklishin michaelklishin merged commit 49d4d39 into master Jun 29, 2020
@michaelklishin michaelklishin deleted the mk-help-command-exit-status branch June 29, 2020 01:33
michaelklishin added a commit that referenced this pull request Jun 29, 2020
Make --help, help usage help messages consistent

(cherry picked from commit 49d4d39)
@michaelklishin
Copy link
Member Author

Backported to v3.8.x.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant