Doc: Glossary alphabetic order is only for English
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the glossary's Sphinx definition and review the :sorted: option described in the issue. Apply it so the glossary is ordered for each language, including the documented changes to the first entries and dunder placement. Build the documentation and inspect the generated glossary in multiple languages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100