docs: add shell completion instructions to README#2371
Open
tysoncung wants to merge 1 commit intojazzband:mainfrom
Open
docs: add shell completion instructions to README#2371tysoncung wants to merge 1 commit intojazzband:mainfrom
tysoncung wants to merge 1 commit intojazzband:mainfrom
Conversation
pip-compile and pip-sync support shell completion via Click, but this wasn't documented in the README. Added instructions for Bash, Zsh, and Fish shells.
Member
|
Thanks for writing this up; these instructions look good. I want to double-check that they render in docs correctly before approving. Please restore the PR template -- per our contributing doc, we do not generally accept contributions which remove the template. You should also add a doc changelog item. |
Member
|
Thanks for mentioning this, I had no idea this feature existing. Added shell completions for downstream Alpine package, might serve as reference for other packagers: https://gitlab.alpinelinux.org/alpine/aports/-/merge_requests/100135 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem
pip-compileandpip-syncsupport shell completion via Click, but this isn't documented anywhere in the README. Users have no way to discover this feature.Closes #1702
Solution
Added a "Shell completion" section to the README with setup instructions for Bash, Zsh, and Fish shells, following Click's shell completion documentation.
Changes
README.md: Added "Shell completion" section with instructions for Bash, Zsh, and Fish