jazzband/pip-tools

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

Open

#1 702 ouverte le 13 oct. 2022

Voir sur GitHub
 (3 commentaires) (1 réaction) (0 assignés)Python (7 230 stars) (605 forks)batch import
docsgood first issue

Description

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

Guide contributeur

Stack technique
python
Domaine
documentationcli
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
basic shell completion knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
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.