Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Named argument -h not explained in rendered documentation #38

Open
arnaudsjs opened this issue Jun 8, 2023 · 0 comments
Open

Named argument -h not explained in rendered documentation #38

arnaudsjs opened this issue Jun 8, 2023 · 0 comments

Comments

@arnaudsjs
Copy link

arnaudsjs commented Jun 8, 2023

Problem description:

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.

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

No branches or pull requests

1 participant