python / python/cpython

Incorrect anchor tags generated in documentation

未關閉
#155,799 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

docs
主要語言
Python
星號
77.2k
分支
36k
PR 合併指標
PR 指標待擷取

描述

Documentation

I have spotted a couple of incorrect anchor links from the pilcrows in some docs pages. It looks like a the sphinx index directive and the headings should be swapped. I will create a pull request.

In The Python Language Reference » 6. Expressions » Identifiers (Names) the pilcrow links to #atom-identifiers instead of #identifiers-names.

In The Python Language Reference » 6. Expressions » Private name mangling the pilcrow links to #index-5 instead of #private-name-mangling.

In Python/C API reference manual » Concrete Objects Layer » MemoryView objects the pilcrow links to #index-0 instead of #memoryview-objects.

I have raised an issue rather than going straight for a PR because you might have concerns about breaking links?

Linked PRs
  • gh-155800

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

檢查與所引用的三個 Python 文件頁面相對應的 Sphinx 索引指令和標題,然後檢視連結的 PR gh-155800。完成的標準是,pilcrow 錨點能解析至 Identifiers (Names)、Private name mangling 和 MemoryView objects 對應的文件化標題錨點,且不會造成非預期的連結失效。

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

評估

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

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

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