Doc: Glossary alphabetic order is only for English
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Sphinx-Definition des Glossars und überprüfe die im Issue beschriebene Option :sorted:. Wende sie an, sodass das Glossar für jede Sprache sortiert ist, einschließlich der dokumentierten Änderungen an den ersten Einträgen und der Platzierung von Dunder-Namen. Baue die Dokumentation und überprüfe das generierte Glossar in mehreren Sprachen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 25/100