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

"Display help text when passed no options" only if no options are necessary #111

Open
l0b0 opened this issue Mar 17, 2023 · 2 comments
Open

Comments

@l0b0
Copy link

l0b0 commented Mar 17, 2023

A lot of commands don't need any options to do useful things, and in those cases they should not print a lot of distracting text. Imagine if ls or ln foo bar printed their help text, that would be terrible.

(If by "option" you meant to say "argument", then that should be clarified, but the same point still holds for ls.)

(I realise this is explained later on, but since all the headings are the same size it's not obvious that the heading comes with some important caveats. Maybe a heading like "Display help when the command would otherwise do nothing" or something to that effect might work?)

@l0b0 l0b0 changed the title "Display help text when passed no options" only if no options make no sense "Display help text when passed no options" only if no options are necessary Mar 17, 2023
@eqn-group
Copy link

This is bad, how would some user who has never used cd ls whoami etc would know what these program does?
my argument is here: #121 (comment)

@l0b0
Copy link
Author

l0b0 commented Mar 21, 2024

This is bad, how would some user who has never used cd ls whoami etc would know what these program does? my argument is here: #121 (comment)

By running COMMAND --help. I think this argument throws out the baby with the bathwater.

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

2 participants