python / python/cpython

Doc: Glossary alphabetic order is only for English

Abierto
#138,700 10 comentarios 6 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

Documentation

Nowadays, the glossary is kept in alphabetical order manually. Here we have two problems:

  • Eventually, the entry order is wrong ( Glossary: locale order )
  • The alphabetical order is kept just in English.

I propose using Sphinx :sorted: option. The glossary will always be ordered in all languages. The two problems above will be solved.

Collateral effects:

  • The two first current entry will change (>>> … → … >>>)
  • Dunder entries will appear before the letter a.

I think the benefits are bigger than the collateral effects. Besides, it is so easy to implement.

Discus topic: https://discuss.python.org/t/glossary-alphabetically-ordering-for-all-language/101778/1

Linked PRs
  • gh-138708
  • gh-138711
  • gh-142640
  • gh-150174
  • gh-150321

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 definición de Sphinx del glosario y revisa la opción :sorted: descrita en el issue. Aplícala para que el glosario esté ordenado para cada idioma, incluidos los cambios documentados en las primeras entradas y la colocación de los nombres dunder. Compila la documentación e inspecciona el glosario generado en varios idiomas.

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
Estancado
Claridad
Bien especificado
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.