python / python/cpython

Doc: Glossary alphabetic order is only for English

オープン
#138,700 コメント 10 件 リアクション 6 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

用語集の Sphinx 定義から始め、issue で説明されている :sorted: オプションを確認します。各言語で用語集が並べ替えられるように適用し、最初のエントリに関する文書化された変更と dunder 名の配置も含めます。ドキュメントをビルドし、複数の言語で生成された用語集を確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。