Improve zsh completion documentation #1169
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
umarcor
approved these changes
Jul 16, 2020
marckhouzam
changed the title
|
I wonder if it's worth mentioning that the completion system needs to be in place before this will work. For example, someone's otherwise starting a new shell with the completion scripts in place won't work. I believe that's the issue here: #1165 (comment) . If someone's using something like ohmyzsh, this is usually taken care of for them, but I think being more verbose could help. Otherwise, this looks good to me! |
|
@jpmcb good point. I'll push a tweak. |
Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
|
@jpmcb Do you think this is clear enough? Also, do you know how to source the powershell completion script? We should add this info as well, but I don't know anything about powershell. |
jpmcb
approved these changes
Jul 19, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation mistakenly mentions that the user could setup zsh completion by doing:
This has been removed. It was noticed in #1165.
Also, the documentation to the changes to zsh completion did not include the fact that the
-prefix is now required to complete flag names (as is done for bash completion). This was added. It was noticed in #899 (comment)