Skip to content

Fixed a few obvious mistakes in c-api docs #11184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 17, 2018
Merged

Fixed a few obvious mistakes in c-api docs #11184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73142db
typo fixed: possible deallocating it -> possibly deallocating it
bombs-kim Dec 17, 2018
1f59f41
Inaccurate content fixed: Py_CLEAR is not used to decrementing the va…
bombs-kim Dec 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/c-api/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ duration of the call.
However, a common pitfall is to extract an object from a list and hold on to it
for a while without incrementing its reference count. Some other operation might
conceivably remove the object from the list, decrementing its reference count
and possible deallocating it. The real danger is that innocent-looking
and possibly deallocating it. The real danger is that innocent-looking
operations may invoke arbitrary Python code which could do this; there is a code
path which allows control to flow back to the user from a :c:func:`Py_DECREF`, so
almost any operation is potentially dangerous.
Expand Down
4 changes: 2 additions & 2 deletions Doc/c-api/refcounting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ objects.
the macro carefully uses a temporary variable and sets the argument to *NULL*
before decrementing its reference count.

It is a good idea to use this macro whenever decrementing the value of a
variable that might be traversed during garbage collection.
It is a good idea to use this macro whenever decrementing the reference
count of an object that might be traversed during garbage collection.


The following functions are for runtime dynamic embedding of Python:
Expand Down