Doc: Glossary alphabetic order is only for English
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 35.9k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con la definizione Sphinx del glossario e rivedi l’opzione :sorted: descritta nell’issue. Applicala in modo che il glossario sia ordinato per ogni lingua, incluse le modifiche documentate alle prime voci e il posizionamento dei nomi dunder. Costruisci la documentazione e ispeziona il glossario generato in più lingue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 25/100