jazzband/pip-tools

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

Open

#1,702 建立於 2022年10月13日

在 GitHub 查看
 (3 留言) (1 反應) (0 負責人)Python (7,230 star) (605 fork)batch import
docsgood first issue

描述

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

貢獻者指南

技術棧
python
領域
documentationcli
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic shell completion knowledge
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
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.