Replace some autogenerated Stable ABI notes with manual ones
Open
Nobody has claimed this yet.
docs
topic-C-API
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
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:
Let's skip the generated notes in this case, and manually add a common note before the table:
Linked PRs
- gh-156871
- gh-156875
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Stable ABI note generation described in the issue and compare the compact tables shown in its examples. The issue names no files or tests; use linked PRs gh-156871 and gh-156875 to identify the affected documentation and confirm that repetitive generated notes are replaced by a shared manual note.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100