[3.13] gh-141004: Improve make check-c-api-docs (GH-143564)#143594
Merged
encukou merged 1 commit intoJan 12, 2026
python:3.13python/cpython:3.13from
encukou:backport-234a15d-3.13encukou/cpython:backport-234a15d-3.13Copy head branch name to clipboard
Merged
[3.13] gh-141004: Improve make check-c-api-docs (GH-143564)#143594encukou merged 1 commit intopython:3.13python/cpython:3.13from encukou:backport-234a15d-3.13encukou/cpython:backport-234a15d-3.13Copy head branch name to clipboard
make check-c-api-docs (GH-143564)#143594encukou merged 1 commit into
python:3.13python/cpython:3.13from
encukou:backport-234a15d-3.13encukou/cpython:backport-234a15d-3.13Copy head branch name to clipboard
Conversation
- Gather all documented names into a set in a single pass. This makes the check much faster. - Do not match substrings (e.g. documenting `PyErr_WarnEx` doesn't mean that `PyErr_Warn` is documented) - Consider `PY`-prefixed names (a lot of old macros use this) (cherry picked from commit 234a15d)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Gather all documented names into a set in a single pass. This makes the check much faster.
Do not match substrings (e.g. documenting
PyErr_WarnExdoesn't mean thatPyErr_Warnis documented)Consider
PY-prefixed names (a lot of old macros use this)(cherry picked from commit 234a15d)