python / python/cpython

Context.items/keys/values docstrings claim lists but return iterators

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

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

docs
主要言語
Python
スター
77.2k
フォーク
35.9k
PR 指標を取得中

説明

_contextvars.Context.items(), .keys(), and .values() return iterator objects, but their docstrings state that they return lists.

Linked PRs
  • gh-142919
  • gh-143266

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

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

はじめの一歩

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

調査の方向性

まず _contextvars.Context.items()、keys()、values() の docstring を見つけ、そこに記載された戻り値の型を、issue で説明されているイテレーターの動作と比較します。3 つすべての docstring がイテレーターを返すことを正確に説明していれば完了です。リンクされている PR gh-142919 と gh-143266 は、この作業がすでに進行中である可能性を示しています。

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

評価

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

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

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