Fix Sphinx warnings on unknown targets#107164
Closed
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
Fix warnings like: * py:data reference target not found: Py_Version * c:func reference target not found: malloc
bedevere-bot added awaiting core review docs 
Contributor
erlend-aasland commented Jul 23, 2023
See also gh-107063 |
Contributor
erlend-aasland commented Jul 23, 2023
... and gh-107062 |
MemberAuthor
vstinner commented Jul 23, 2023
Docs / Docs job failed with: |
Contributor
erlend-aasland commented Jul 23, 2023
No, you misread the CI information. This is what you need to fix ;) |
| for the ``s`` and ``s#`` formats, the required data is copied. Buffers provided | ||
| by the caller are never referenced by the objects created by | ||
| :c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc` | ||
| :c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc` |
Contributor
There was a problem hiding this comment.
This is not needed; malloc is in the nitignore list in Doc/conf.py.
Suggested change
| :c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc` | |
| :c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`malloc` |
MemberAuthor
There was a problem hiding this comment.
I saw warnings on this function on this documentation page. Maybe the PR was outdated, I don't recall the details.
I didn't know nitignore, that sounds very useful!
| :c:func:`Py_BuildValue`. In other words, if your code invokes :c:func:`!malloc` | ||
| and passes the allocated memory to :c:func:`Py_BuildValue`, your code is | ||
| responsible for calling :c:func:`free` for that memory once | ||
| responsible for calling :c:func:`!free` for that memory once |
Contributor
There was a problem hiding this comment.
Ditto. See Doc/conf.py
Suggested change
| responsible for calling :c:func:`!free` for that memory once | |
| responsible for calling :c:func:`free` for that memory once |
MemberAuthor
vstinner commented Jul 26, 2023
I reworked this change into a serie of changes: I created issue #107298. I abandon this PR. |
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.
Fix warnings like:
📚 Documentation preview 📚: https://cpython-previews--107164.org.readthedocs.build/