python / python/cpython

Doc: Glossary alphabetic order is only for English

未关闭
#138,700 10 条评论 6 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从术语表的 Sphinx 定义开始,并检查 issue 中描述的 :sorted: 选项。应用该选项,使术语表针对每种语言进行排序,包括文档中记录的首批条目变更以及 dunder 名称的位置调整。构建文档,并检查多种语言中生成的术语表。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
描述清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。