python / python/cpython

Docs: inline markup in `c-api/typeobj.rst` legend is not rendered because of `.. code-block:: none`

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

还没有人认领这个 Issue。

docs
主要语言
Python
星标
77.2k
派生
35.9k
PR 合并指标
PR 指标待抓取

描述

Documentation

In Doc/c-api/typeobj.rst, the two legends that explain the "D" (default) and "I" (inheritance) columns of the PyTypeObject quick-reference table (lines 172–187) are wrapped in .. code-block:: none. Because code-block renders its content verbatim:

  • *PyType_Ready* and *NULL* appear with literal asterisks.
  • PyType_Ready is plain text instead of a cross-reference to :c:func:PyType_Ready.
  • NULL is plain text instead of the NULL inline literal used elsewhere in the same file.
Image
Linked PRs
  • gh-148962

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

打开 Doc/c-api/typeobj.rst,检查第 172–187 行附近的两个 legend。检查文件其他位置的已渲染文档如何处理 PyType_Ready 交叉引用和 NULL 内联字面量。完成的标准是两个 legend 都渲染 markup,而不是字面量星号,并采用预期的引用和字面量格式。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。