Update function signatures to use `*` and `/` as needed
オープン
まだ誰も着手していません。
docs
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 35.9k
- PR マージ指標
- PR 指標を取得中
説明
Documentation
[!CAUTION]
For new contributors, please do not consider this issue as an "easy" one. While the changes may seem mechanical, they are not necessarily trivial as this requires to know what really happens (both at a Python and a C level).
This is tracks cases where changes need to be made to enact the Editorial Board's decision for function signature markup.
- builtins:
-
min() -
max() -
range() -
map()
-
- methods on builtins:
-
dict.get(),dict.setdefault()
-
See also:
- https://discuss.python.org/t/editorial-board-decisions/58580
- https://github.com/python/cpython/pull/129669#issuecomment-2636839784
- https://discuss.python.org/t/81003
- https://devguide.python.org/documentation/style-guide/#function-signatures
- https://discuss.python.org/t/58750
Linked PRs
- gh-131868
- gh-131886
- gh-128208
- gh-131893
- gh-131894
- gh-131990
- gh-131992
- gh-132029
- gh-136085
- gh-136120
- gh-136121
- gh-137656
- gh-137657
- gh-137902
- gh-137904
- gh-139978
- gh-140270
- gh-144856
- gh-156179
- gh-156267
- gh-156268
- gh-156269
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
残っている未チェックの map() 項目から始め、関数シグネチャーに関するガイダンスと、関連付けられた Editorial Board の議論を確認してください。関連する組み込み関数のドキュメントと、既存の関連 PRs を調査してください。合意されたマークアップに従って、該当するシグネチャーが一貫して * と / を使用するようになれば、作業は完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- c, python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100