jazzband/pip-tools

Document that pyproject.toml dependencies are supported

クローズ

#1,528 opened on 2021/11/05

GitHub で見るコントリビューターガイド
 (3 件のコメント) (7 件のリアクション) (0 人の担当者)Python (670 件のフォーク)batch import
PR wanteddocsgood first issue

Repository metrics

Stars
 (8,008 個のスター)
PR merge metrics
 (PR metrics pending)

説明

What's the problem this feature will solve?

Issues like: #1510, general confusion

Describe the solution you'd like

At the moment, the docs include phrases like:

The pip-compile command lets you compile a requirements.txt file from your dependencies, specified in either setup.py or requirements.in.

pip-compile generates a requirements.txt file using the latest versions that fulfil the dependencies of setup.py or requirements.in.

To me, and I assume the person who opened #1510, this reads like only setup.py or requirements.in are supported.

コントリビューターガイド

調査方針
pyproject.toml が依存関係の指定にサポートされていることを、setup.py や requirements.in と同様に明示するようにドキュメントを更新します。既存のドキュメントファイル（README、docs/index.rst など）を確認し、関連する文を修正してください。また、更新が必要な他の参照がないか確認してください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
なし
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90