jazzband/pip-tools

[advice] pip-{compile,sync} have completions, why not add some document about it to README.md?

Open

Aperta il 13 ott 2022

Vedi su GitHub
 (3 commenti) (1 reazione) (0 assegnatari)Python (7230 star) (605 fork)batch import
docsgood first issue

Descrizione

See https://click.palletsprojects.com/en/8.1.x/shell-completion/#enabling-completion.

_PIP_SYNC_COMPLETE=zsh_source pip-sync |sudo tee /usr/share/zsh/site-functions/_pip-sync
_PIP_COMPILE_COMPLETE=zsh_source pip-compile |sudo tee /usr/share/zsh/site-functions/_pip-compile

Guida contributor

Tech stack
python
Dominio
documentationcli
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
basic shell completion knowledge
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90
Direzione di ricerca
Add shell completion commands to README.md. The issue provides the exact commands for zsh. Consider providing examples for other shells as well. The README should document how to enable completion for pip compile and pip sync.