Clarify best practices with ref target labels in docs
@CAM-Gerlach 已經在處理了。
開始於 2022年8月3日。
評估
這個 Issue 還沒有評估資料。
描述
On python/cpython#94636 , specifically https://github.com/python/cpython/pull/94636#discussion_r934008442 , @ezio-melotti , @erlend-aasland and I discussed that that it might be helpful to clarify in the devguide some additional guidance related to reference target labels in the Cross-linking markup section.
Specifically, it could mention that whenever possible, the existing ref target should be left place (either instead of or addition to adding a new one) when sections are changed or moved, since it ensures any inbound internal or Intersphinx references don't break or need to be changed, as well as any external links that anchor (provided that it wasn't moved to a different page without a redirection).
Also, it could provide a guideline and examples on how ref labels should be "namespaced" to avoid conflicts, i.e. by the module name for library docs, or the page name elsewhere, documenting existing (if not always consistent) convention.
If we agree this would be helpful, I can submit a PR on this once #916 is merged.
- 主要語言
- Python
- 星號
- 2.1k
- 分支
- 1k
- 平均合併
- 2 天 12 小時
- 30 天內合併 PR
- 12
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
python/devguide 的其他 Issue
-
type-feature
難度 2/5 1-3 小時 新手友好度 68/100
-
type-feature
難度 2/5 1-3 小時 新手友好度 68/100
-
topic-building python type-feature
難度 2/5 1-3 小時 新手友好度 65/100
-
needs: decision topic-test type-bug
難度 2/5 1-3 小時 新手友好度 78/100
-
topic-dev process type-feature
難度 2/5 1-3 小時 新手友好度 62/100
相似的 Issue
-
enhancement
難度 2/5 1-3 小時 新手友好度 70/100
canonical/paas-charm#368 · 1 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 75/100
-
tech debt
難度 2/5 1-3 小時 新手友好度 75/100
-
難度 1/5 1 小時以內 新手友好度 90/100
StevenBlack/hosts#3256 ·
-
難度 1/5 1 小時以內 新手友好度 90/100
qualcomm/qai-appbuilder#275 ·