Fix Sphinx warnings in C API doc #107274
Closed
Fix Sphinx warnings in C API doc #107274
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
|
Hum. I already created PR #107164 but this one is supposed to be more complete. But then I fixed more and more warnings in a local branch, and quickly I went to too many directions. Now I'm confused and I'm not sure how to split this work. So instead I created PR #107278 to first fix warnings like |
| .. c:function:: int PyBool_Check(PyObject *o) | ||
| Return true if *o* is of type :c:data:`PyBool_Type`. This function always | ||
| Return true if *o* is of type :c:data:`!PyBool_Type`. This function always |
There was a problem hiding this comment.
Would not be better to add the documentation for PyBool_Type?
| Use this for numeric comparisons, e.g. ``#if PY_VERSION_HEX >= ...``. | ||
|
|
||
| This version is also available via the symbol :data:`Py_Version`. | ||
| This version is also available via the symbol :c:var:`Py_Version`. |
|
I reworked this change into a serie of changes: I created issue #107298. I abandon this PR. |
Sign up for free
to 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.
📚 Documentation preview 📚: https://cpython-previews--107274.org.readthedocs.build/