python / python/cpython

`dis` module documentation lacks references to glossary

未關閉
#137,352 3 則留言 4 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

docs
主要語言
Python
星號
77.2k
分支
35.9k
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

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

開啟連結的 dis 模組文件頁面,並將其中的術語表術語與現有的術語表連結進行比較。為已識別的出現位置新增缺少的術語表參照,然後確認頁面上每個相關的術語表術語出現位置都連結至其術語表項目。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。