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

How to correctly use shtab #132

Open
JakobDev opened this issue Mar 20, 2023 · 2 comments
Open

How to correctly use shtab #132

JakobDev opened this issue Mar 20, 2023 · 2 comments
Labels
documentation Markdown files duplicate Déjà lu

Comments

@JakobDev
Copy link

shtab looks like a nice thing that I want to add to my programs. But there's one big question: How can I use shtab, so It's useable for end users? The documentation says, that end users can actually using the shtab cli or by adding a new cli option provided by shtab to the Program. But that is not very useful at all. The User first needs to know that this can be done. Putting it in some documentation where almost nobody reads it. And the User also needs to add it to the .bashrc or .zshrc to make it work on startup.

The completion should work out of the Box after installing. A solution would be to put the files in the specific directories (e.g. usr/share/bash-completion/completions), but this is not supported by pip.

@casperdcl
Copy link
Collaborator

casperdcl commented Mar 20, 2023

Duplicate of #122?
In particular, the end-user docs link at the bottom of #122 (comment) might be helpful (related to #119).

@casperdcl casperdcl added documentation Markdown files duplicate Déjà lu labels Mar 20, 2023
@LimbersMay
Copy link

That's true, this is one of the worst documentations I've read, it doesn't even specify how to make it all work

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Markdown files duplicate Déjà lu
Projects
None yet
Development

No branches or pull requests

3 participants