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
The rendered documentation of a certain command looks as follows:
sample apply [-h] [-r] [--tree] [--dry] [--force] path default_string
Positional Arguments
path
Specify path to provision script. provision.py in current directory by default. Also may include url.
Default: “provision.py”
default_string
Ensure variables are filled in (default “I am a default”)
Default: “I am a default”
Named Arguments
-r, --rollback
If specified will rollback all resources applied.
Default: False
--tree
Print resource tree
Default: False
--dry
Just print changes list
Default: False
--force
Apply without confirmation
Default: False
Every argument is documented except for the -h option. This option just displays the help message, but this is not clear from the rendered documentation. In many command line tools, for example, -h is an abbreviation for --host, indicating the host to which the tool should connect.
Proposal:
I don't think there is a need to mention the -h option in the list of named arguments over and over again for every command. The meaning of the long version of this option, --help, is very well known in general. So replacing -h with --help in the signature of the command would already resolve this problem.
The text was updated successfully, but these errors were encountered:
Problem description:
The rendered documentation of a certain command looks as follows:
Every argument is documented except for the
-h
option. This option just displays the help message, but this is not clear from the rendered documentation. In many command line tools, for example,-h
is an abbreviation for--host
, indicating the host to which the tool should connect.Proposal:
I don't think there is a need to mention the
-h
option in the list of named arguments over and over again for every command. The meaning of the long version of this option,--help
, is very well known in general. So replacing-h
with--help
in the signature of the command would already resolve this problem.The text was updated successfully, but these errors were encountered: