Document the current practice for SystemError
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 36k
- Merge medio
- 1 d 9 h
- PR fusionados (30 d)
- 558
Descripción
@malemburg pointed that the documentation of SystemError only refers to CPython internal errors as the source.
https://docs.python.org/3/library/exceptions.html#SystemError
On practice, SystemError is also raised on improper use of the C API (like NULL pointer, or negative size, or wrong type in the concrete API) if it is possible to detect such error and it is not too costly (macros usually lack any argument checks). An alternative to SystemError is a crash or memory corruption. Currently the main source of SystemError is errors in third-party extensions, not in the Python core or standard extensions.
The documentation looks outdated, perhaps it predates the public C API.
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
Comienza con la sección SystemError en docs.python.org/3/library/exceptions.html#SystemError y revisa la descripción del issue sobre el uso incorrecto de la C API. Actualiza la documentación para reflejar la práctica actual indicada, incluido el uso indebido detectable en las extensiones, y asegúrate de que el texto resultante ya no implique que los errores internos de CPython son la única fuente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- c, python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100