What type `bound` parameter of `typing.TypeVar` accepts should be explained more clearly
Ouverte
Personne n'a encore pris cette issue.
docs
topic-typing
triaged
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Documentation
*Notes:
- Python 3.14.3
For T and A, what type is accepted is clearly explained in the example of typing.TypeVar while for S isn't explained clearly even though str itself is also accepted as shown below:
T = TypeVar('T') # Can be anything
S = TypeVar('S', bound=str) # Can be any subtype of str <- Here
A = TypeVar('A', str, bytes) # Must be exactly str or bytes
So, S should be explained more clearly as shown below:
S = TypeVar('S', bound=str) # Can be str or any subtype of str
Linked PRs
- gh-145525
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la documentation de typing.TypeVar et ses exemples T, S et A liés dans l’issue. Clarifiez l’exemple bound=str afin d’indiquer explicitement que str lui-même et ses sous-types sont acceptés, puis vérifiez que la documentation rendue utilise une formulation cohérente.
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
- 30/100