Document that we can't use new stdlib symbols until added to type-checkers
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 5.1k
- Forks
- 2.1k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 82
Descripción
https://github.com/python/typeshed/pull/11890#discussion_r1597530831
An unwritten convention (because we've been bitten by it a few times in the past), is to not use newly added symbols from the stdlib stubs until all supported type-checkers (pyright, mypy, pytype??, realistically we're always waiting on mypy release because pyright releases so often) updated their vendored version of typeshed.
This is a suggestion to add this convention to the contributing guideline in a more official way, and to teach contributors about this unobvious gotcha.
Relates to #5835
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza leyendo la guía de contribución y la discusión en typeshed PR 11890, especialmente el comentario enlazado, para entender la convención existente. Documenta que los símbolos de stub de la stdlib añadidos recientemente deben esperar hasta que los type-checkers compatibles hayan actualizado su versión vendored de typeshed; se considerará terminado cuando la guía sea clara para los contributors y se haya actualizado la guía pertinente.
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
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 68/100