python / python/cpython

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

Ouverte
#142,918 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

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

Linked PRs
  • gh-142919
  • gh-143266

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser les docstrings de _contextvars.Context.items(), keys() et values(), puis comparez leurs types de retour indiqués avec le comportement des itérateurs décrit dans l’issue. Le travail est terminé lorsque les trois docstrings décrivent correctement le renvoi d’itérateurs ; les PR liés gh-142919 et gh-143266 indiquent que ce travail est peut-être déjà en cours.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.