`dis` module documentation lacks references to glossary
オープン
まだ誰も着手していません。
docs
- 主要言語
- Python
- スター
- 77.2k
- フォーク
- 36k
- PR マージ指標
- PR 指標を取得中
説明
Documentation
On dis page some terms do not have references to glossary. For example, "borrowed reference" is mentioned and listed in glossary, but no mention contains an actual link to glossary.
Also, many terms have reference only in some places, like "generator", which has only 2 links out of ~20 occurrences on the page.
My thoughts are that we should add a link for every glossary term occurrence (at least on this page). If you agree with proposed changes, I'd be happy to make a PR. :)
Linked PRs
- gh-137787
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンク先の dis モジュールのドキュメントページを開き、その用語集の用語を、すでに存在する用語集へのリンクと比較します。特定した出現箇所に不足している用語集への参照を追加し、その後、ページ上の関連する用語集の用語の出現箇所がすべて用語集の項目にリンクされていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100