Skip to content

Commit 5137002

Browse files
miss-islingtonAA-Turner
authored andcommitted
[3.11] gh-93738: Documentation C syntax (:c:data:view->obj -> :c:expr:view->obj) (GH-97773) (#97867)
:c:data:`view->obj` -> :c:expr:`view->obj` (cherry picked from commit fa59bda) Co-authored-by: Adam Turner <[email protected]>
1 parent 65b2591 commit 5137002

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Doc/c-api/typeobj.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -2321,24 +2321,24 @@ Buffer Object Structures
23212321
steps:
23222322

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

23262326
(2) Fill in the requested fields.
23272327

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

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

23322332
(5) Return ``0``.
23332333

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

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

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

23442344
The individual fields of *view* are described in section
@@ -2380,7 +2380,7 @@ Buffer Object Structures
23802380
*view* argument.
23812381

23822382

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

0 commit comments

Comments
 (0)