python / python/cpython

What type `bound` parameter of `typing.TypeVar` accepts should be explained more clearly

Abierto
#145,524 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs topic-typing triaged
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con la documentación de typing.TypeVar y sus ejemplos de T, S y A enlazados en el issue. Aclara el ejemplo bound=str para indicar explícitamente que se aceptan str y sus subtipos, y después comprueba que la documentación renderizada use una redacción coherente.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.