python / python/cpython

Doc: Glossary alphabetic order is only for English

Ouverte
#138,700 10 commentaires 6 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la définition Sphinx du glossaire et examinez l’option :sorted: décrite dans l’issue. Appliquez-la afin que le glossaire soit trié pour chaque langue, y compris les changements documentés concernant les premières entrées et le placement des noms dunder. Construisez la documentation et inspectez le glossaire généré dans plusieurs langues.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.