python / python/cpython

Incorrect anchor tags generated in documentation

未关闭
#155,799 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs
主要语言
Python
星标
77.2k
派生
35.9k
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 摘要。