Clarify module.__file__ documentation in the data model reference
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 77.2k
- Forks
- 35.9k
- Métricas de merge de PR
- Métricas de PR pendientes
Descripción
Documentation
The module.__file__ section in Doc/reference/datamodel.rst has two problems:
- it says "Both attributes should be a
str" even though the section is describing a single attribute - it does not clearly explain the path form readers should expect from
__file__
The docs should say that __file__ is optional, should be a str when set, and is usually an absolute path for modules loaded from a file by the import system, while callers that require an absolute path should normalize it explicitly.
Linked PRs
- gh-150273
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
Abre la sección de module.file en Doc/reference/datamodel.rst y revisa su redacción actual según los requisitos del issue. Se considera terminado cuando el texto describe el atributo como opcional, identifica str y el comportamiento habitual con rutas absolutas, y señala que los llamadores que necesiten una ruta absoluta deben normalizarla explícitamente.
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
- 25/100