bpo-33592: Document the C API in PEP 567 (contextvars) #7033
Conversation
This file contains 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
serhiy-storchaka
approved these changes
May 22, 2018
There was a problem hiding this comment.
Thanks @elprans!
LGTM, but please add few notes about error cases.
Doc/c-api/contextvars.rst
Outdated
| .. c:function:: int PyContext_CheckExact(PyObject *o) | ||
|
|
||
| Return true if *o* is of type :c:data:`PyContext_Type`. *o* must not be | ||
| *NULL*. |
There was a problem hiding this comment.
Please add "This function always succeeds." (and for two functions below).
Doc/c-api/contextvars.rst
Outdated
| .. c:function:: int PyContext_ClearFreeList() | ||
|
|
||
| Clear the context variable free list. Return the total number of | ||
| freed items. |
There was a problem hiding this comment.
"This function always succeeds."
Doc/c-api/contextvars.rst
Outdated
|
|
||
| Create a new ``ContextVar`` object. The *name* parameter is used | ||
| for introspection and debug purposes. The *def* parameter may optionally | ||
| specify the default value for the context variable. |
There was a problem hiding this comment.
Mention that NULL is returned on error.
serhiy-storchaka
added
docs
elprans
force-pushed
the
document-contextvars-capi
branch
from
3bc5844
to
96ecdcc
Compare
elprans
force-pushed
the
document-contextvars-capi
branch
from
96ecdcc
to
8e4531a
Compare
1st1
approved these changes
May 22, 2018
|
Merged, thanks @elprans! Also thanks to @serhiy-storchaka for the review! |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 22, 2018
(cherry picked from commit b2f5f59) Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
|
GH-7059 is a backport of this pull request to the 3.7 branch. |
miss-islington
added a commit
that referenced
this pull request
May 22, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://bugs.python.org/issue33592