gh-141004: Document missing PyCFunction* and PyCMethod* APIs
#141253
+83
−0
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-app
bot
added
awaiting core review
docs
sharktide
reviewed
Nov 15, 2025
Contributor
There was a problem hiding this comment.
I suggested some updates so the tone is consistent (eg. We use trailing "s" chars like "returns" but we use "Get" instead of "Gets") so we should keep the same style for consistency and to improve reading flow
I also surrounded true and false with backticks
| .. c:function:: int PyCMethod_Check(PyObject *f) | ||
| Return true if *f* is an instance of the :c:type:`PyCMethod_Type` type |
Contributor
There was a problem hiding this comment.
Suggested change
| Return true if *f* is an instance of the :c:type:`PyCMethod_Type` type | |
| Returns ``true`` if *f* is an instance of the :c:type:`PyCMethod_Type` type. Otherwise returns ``false``. |
Comment on lines
+502
to
+503
| Return true if *f* is an instance of the :c:type:`PyCFunction_Type` type | ||
| or a subtype of it. This function always succeeds. |
Contributor
There was a problem hiding this comment.
Suggested change
| Return true if *f* is an instance of the :c:type:`PyCFunction_Type` type | |
| or a subtype of it. This function always succeeds. | |
| Returns ``true`` if *f* is an instance of the :c:type:`PyCFunction_Type` type | |
| or a subtype of it. Otherwise returns ``false``. This function always succeeds. |
| .. c:function:: int PyCFunction_GetFlags(PyObject *func) | ||
| Get the function flags on *func* as they were passed to |
Contributor
There was a problem hiding this comment.
Suggested change
| Get the function flags on *func* as they were passed to | |
| Gets the function flags on *func* as they were passed to |
| .. c:function:: PyCFunction PyCFunction_GetFunction(PyObject *func) | ||
| Get the function pointer on *func* as it was passed to |
Contributor
There was a problem hiding this comment.
Suggested change
| Get the function pointer on *func* as it was passed to | |
| Gets the function pointer on *func* as it was passed to |
| .. c:function:: PyObject *PyCFunction_GetSelf(PyObject *func) | ||
| Get the "self" object on *func*. This is the object that would be passed |
Contributor
There was a problem hiding this comment.
Suggested change
| Get the "self" object on *func*. This is the object that would be passed | |
| Gets the "self" object on *func*. This is the object that would be passed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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--141253.org.readthedocs.build/en/141253/c-api/structures.html#implementing-functions-and-methods