Skip to content

gh-93738: Documentation C syntax (:c:data:view->obj -> :c:expr:view->obj) #97773

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 1 commit into from
Oct 4, 2022
Merged

gh-93738: Documentation C syntax (:c:data:view->obj -> :c:expr:view->obj) #97773

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2356,24 +2356,24 @@ Buffer Object Structures
steps:

(1) Check if the request can be met. If not, raise :c:data:`PyExc_BufferError`,
set :c:data:`view->obj` to ``NULL`` and return ``-1``.
set :c:expr:`view->obj` to ``NULL`` and return ``-1``.

(2) Fill in the requested fields.

(3) Increment an internal counter for the number of exports.

(4) Set :c:data:`view->obj` to *exporter* and increment :c:data:`view->obj`.
(4) Set :c:expr:`view->obj` to *exporter* and increment :c:expr:`view->obj`.

(5) Return ``0``.

If *exporter* is part of a chain or tree of buffer providers, two main
schemes can be used:

* Re-export: Each member of the tree acts as the exporting object and
sets :c:data:`view->obj` to a new reference to itself.
sets :c:expr:`view->obj` to a new reference to itself.

* Redirect: The buffer request is redirected to the root object of the
tree. Here, :c:data:`view->obj` will be a new reference to the root
tree. Here, :c:expr:`view->obj` will be a new reference to the root
object.

The individual fields of *view* are described in section
Expand Down Expand Up @@ -2415,7 +2415,7 @@ Buffer Object Structures
*view* argument.


This function MUST NOT decrement :c:data:`view->obj`, since that is
This function MUST NOT decrement :c:expr:`view->obj`, since that is
done automatically in :c:func:`PyBuffer_Release` (this scheme is
useful for breaking reference cycles).

Expand Down