python / python/cpython

Replace some autogenerated Stable ABI notes with manual ones

未关闭
#156,870 2 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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

描述

Documentation

We generate Stable ABI notes automatically. This works well in most cases.
But in compact lists/tables of many similar definitions, the notes get repetitive, and take up too much vertical space:

Image

Let's skip the generated notes in this case, and manually add a common note before the table:

Image
Linked PRs
  • gh-156871
  • gh-156875

贡献指南

打开贡献指南

从这里开始

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

调研方向

检查 issue 中描述的 Stable ABI 注释生成,并比较其示例中显示的紧凑表格。issue 未列出任何文件或测试;使用链接的 PR gh-156871 和 gh-156875 来确定受影响的文档,并确认重复的生成注释已被一个共享的手动注释替代。

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

评估

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

把新 issue 发到你的邮箱

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