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

add help command for consistent UX #82

Open
Kangie opened this issue Aug 30, 2023 · 2 comments
Open

add help command for consistent UX #82

Kangie opened this issue Aug 30, 2023 · 2 comments

Comments

@Kangie
Copy link

Kangie commented Aug 30, 2023

If nattka uses commands like nattka apply, nattka commit, etc. it only makes sense to support nattka help as a command as well - to do otherwise is inconsistent with the rest of the nattka UX.

Additionally, nattka help command should show the appropriate help, perhaps with an example?

$ nattka help make-package-list
nattka make-package-list attempts to create a package list for keywording PACKAGE (along with any dependencies).

usage:
    nattka make-package-list [-h] [-a ARCH] [-p PROFILES] [-s] package [package ...]

examples: 
    $ nattka make-package-list -s 'www-client/chromium-116.0.5845.140' -a amd64 -a arm64

positional arguments:
. . .
@arthurzam
Copy link
Contributor

I think in python world, the normal interface is command subcommand --help. This is also the interface for git as example, so isn't only python world.

@thesamesam
Copy link
Contributor

thesamesam commented Sep 2, 2023

See https://clig.dev/#help which agrees with the original issue, although funnily enough it says "if you're git-like, you should support help", even though git doesn't...

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

3 participants