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

Document usage for fish completion #1115

Closed
mayankshah1607 opened this issue May 15, 2020 · 5 comments
Closed

Document usage for fish completion #1115

mayankshah1607 opened this issue May 15, 2020 · 5 comments

Comments

@mayankshah1607
Copy link

Now that #1048 has been merged, it would be nice to have some documentation around how to generate completion scripts for fish shell :)

@marckhouzam
Copy link
Collaborator

We have this for now: https://github.com/spf13/cobra/blob/master/fish_completions.md

And PR #1070 completely re-organises the documentation around completion.

You can read the proposed new documentation here for now:
Completion in general: https://github.com/VilledeMontreal/cobra/blob/feat/zshCompletionV2/shell_completions.md
Fish section: https://github.com/VilledeMontreal/cobra/blob/feat/zshCompletionV2/shell_completions.md#fish-completions

If you have any suggestion to improve the doc, please do comment on the PR.
Thank you

@mayankshah1607
Copy link
Author

Thanks for the quick response, @marckhouzam !
Can we add a link in the readme, like this ? Becomes a lot easier to find :)
Thanks

@marckhouzam
Copy link
Collaborator

Can we add a link in the readme, like this ? Becomes a lot easier to find :)

PR #1070 is reworking all the doc for completion. But I don't know if/when it will be accepted. In the mean time you could always post a PR to add the link you suggest to the main README.

@github-actions
Copy link

This issue is being marked as stale due to a long period of inactivity

@marckhouzam
Copy link
Collaborator

Now that #1070 has been merged we have better docs for fish completion. An example is given here:
https://github.com/spf13/cobra/blame/master/shell_completions.md#L57

I believe this issue can be closed. /cc @jpmcb

@jpmcb jpmcb closed this as completed Jul 17, 2020
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