pypa / pypa/packaging.python.org

Document discouraged / deprecated setup arguments

オープン
#293 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

type: enhancement
主要言語
Python
スター
1.7k
フォーク
1.7k
平均マージ
3日 12時間
マージ済み PR(30日)
4

説明

We presently document an opinionated set of setup args that are applicable to most packaging scenarios. We also have additional topics for more advanced use cases. However, we don't presently document arguments that should never be used or used with extreme caution.

So far, the ones I'm aware of are:

  1. requires dates from a pre-PyPI & setuptools time and has now been replaced by install_requires.
  2. provides is unused.
  3. obsoletes is unused.
  4. platforms has ambiguous behavior.
  5. dependency_links isn't supported by pip.
  6. download_url has surprising behavior and shouldn't be used.

(Original context: #264)

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

これらの注記をどこに記載するかを決める前に、setup引数に関する既存のドキュメントと issue #264 のコンテキストを確認してください。requires、provides、obsoletes、platforms、dependency_links、download_url に関する注意事項を記載し、6つすべての引数を扱った時点で完了とします。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。