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.

Sign up for GitHub

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

Jump to bottom

CLI help sections cleanup #164

Closed
slarse opened this issue Apr 7, 2019 · 3 comments · Fixed by #283
Closed

CLI help sections cleanup #164

slarse opened this issue Apr 7, 2019 · 3 comments · Fixed by #283
Labels
cli enhancement New feature or request
Milestone
v2.0.0

Comments

@slarse
Copy link
Collaborator

slarse commented Apr 7, 2019

The CLI -h sections are a bit bloated with stuff that you rarely put on the command line, such as the base url and the API token. It would possibly be a good idea to hide these if there are defaults, and add little note that they are hidden.

It would be even better if it was possible to specify a pre-parser option for showing them anyway.

This can also be a 2.0 feature as it's a bit tricky to implement and not crucial to current operation.
@slarse slarse added enhancement New feature or request cli labels Apr 7, 2019
@slarse slarse added this to the v2.0.0 milestone Apr 7, 2019
@slarse slarse mentioned this issue Apr 7, 2019
Closed
@slarse
Copy link
Collaborator Author

slarse commented May 6, 2019

Can use argparse.SUPPRESS conditionally to hide options with defaults

@slarse
Copy link
Collaborator Author

slarse commented Jul 6, 2019

Also, the help texts for the subcommands aren't particularly good.

@slarse
Copy link
Collaborator Author

slarse commented Jul 8, 2019

Arguments that are not required (#274) should also be suppressed

@slarse slarse mentioned this issue Jul 9, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cli enhancement New feature or request
Projects
None yet
Milestone
v2.0.0
Development

Successfully merging a pull request may close this issue.

[feat] Hide configured and optional args repobee/repobee
1 participant
@slarse