You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Inconsistent SYNOPSIS brackets: required options shown as optional, opposite of arguments #1389
Given a command with a required option --name and an optional option --times (with a default), the SYNOPSIS section of its help output shows:
hi [--name String] --times int --help
This is backwards: --name is required but shown bracketed (looking optional), while --times is optional but shown bare (looking required). By Unix convention, [ ] should mark the optional element, not the required one. This is also inconsistent with how positional arguments are rendered in the same help output (there, arguments with a default value are correctly shown bracketed as optional). Options and arguments follow opposite, contradictory conventions within the same command's help text.
Activity
Fix inverted SYNOPSIS brackets in help output
Fix inverted SYNOPSIS brackets in help output