Skip to content

Commit

Permalink
[3.10] gh-93738: Documentation C syntax (:c:data:view->obj -> :c:ex…
Browse files Browse the repository at this point in the history
…pr:`view->obj`) (GH-97773) (#97868)

:c:data:`view->obj` -> :c:expr:`view->obj`
(cherry picked from commit fa59bda)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
  • Loading branch information
miss-islington and AA-Turner committed Oct 5, 2022
1 parent 994eaa3 commit 95289bf
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Doc/c-api/typeobj.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2327,24 +2327,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 @@ -2386,7 +2386,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

0 comments on commit 95289bf

Please sign in to comment.