Python documentation in Texinfo format: Problems with `dircategory` and `direntry` commands
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 Python documentation could be downloaded in Texinfo and Info format.
Which is great, I'm very very thankful for it.
But their is multiple problems, in the python.texi file, with the @dircategory and @direntry commands.
The @dircategory is now set to "Miscellaneous". It should be set to a more descriptive category. Like "Programming" or "Programming language" or "Python". A "Python" category could be re-used by other manuals related to Python. For example a manual for a Python framework or library.
In the @direntry command:
- The info file name, in parenthesis, should not include the
.infoextension [1] - The menu entry description should be more descriptive than "One line description of project"
[1] https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Listing-a-New-Info-File
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 python.texi e inspecciona sus comandos @dircategory y @direntry; después compara sus valores actuales con las indicaciones de Texinfo enlazadas en el issue. Se considera terminado cuando la categoría es descriptiva, el nombre del archivo Info omite la extensión .info y la descripción del menú identifica la documentación de Python en lugar de usar el texto de marcador de posición.
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
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 35/100