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

Better --help text in krr #296

Merged
merged 1 commit into from
Jun 20, 2024
Merged

Better --help text in krr #296

merged 1 commit into from
Jun 20, 2024

Conversation

aantn
Copy link
Contributor

@aantn aantn commented Jun 20, 2024

Motivation

Users often run krr --help to learn about KRR cli flags, but that command doesn't output most flags! Most of the flags are only shown for krr simple --help. This PR tells users where to look for the real cli flags.

Alternatives

Ideally krr --help would show all cli flags, but I don't know how to do this with the library we use (typer) and I suspect it isn't possible. So while I would prefer doing that, this was the only solution I found.

@aantn aantn requested a review from pavangudiwada June 20, 2024 06:57
Copy link
Contributor

@pavangudiwada pavangudiwada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@pavangudiwada pavangudiwada merged commit c9554c0 into main Jun 20, 2024
2 checks passed
@pavangudiwada pavangudiwada deleted the better-cli-help-text branch June 20, 2024 07:24
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

Successfully merging this pull request may close these issues.

2 participants