gh-101100: Fix sphinx warnings in c-api/gcsupport.rst#114786
Merged
Uh oh!
There was an error while loading. Please reload this page.
Conversation
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
bedevere-appbot added docs 
Doc/c-api/gcsupport.rst Outdated
| Returns the resized object of type ``TYPE*`` (refers to any C type) | ||
| or ``NULL`` on failure. | ||
| *op* must of type :c:expr:`PyVarObject *` |
sobolevn commented Jan 31, 2024
Uh oh!
There was an error while loading. Please reload this page.
hugovk approved these changes Jan 31, 2024
hugovk added needs backport to 3.11 
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 10, 2024
…GH-114786) (cherry picked from commit 4821f08) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Sorry, @sobolevn and @hugovk, I could not cleanly backport this to |
GH-115263 is a backport of this pull request to the 3.12 branch. |
hugovk pushed a commit to hugovk/cpython that referenced this pull request Feb 13, 2024
…ythonGH-114786) (cherry picked from commit 4821f08) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
GH-115430 is a backport of this pull request to the 3.11 branch. |
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this pull request Feb 14, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
Before:
I think that
PyObject_GC_Resizeshould be documented as a macro. Because it is:cpython/Include/objimpl.h
Lines 179 to 180 in c8cf5d7
Previous error was correct, there's no such thing as
TYPEoutside of the macro context.📚 Documentation preview 📚: https://cpython-previews--114786.org.readthedocs.build/en/114786/c-api/gcsupport.html#c.PyObject_GC_Resize