languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-09-16 05:19:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse source 
:c:data:`view->obj` -> :c:expr:`view->obj`
This commit is contained in:
Adam Turner 2022-10-05 00:18:09 +01:00 committed by GitHub
parent a77d9dedcd
commit fa59bda8d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Doc/c-api/typeobj.rst
View file

@ -2356,13 +2356,13 @@ Buffer Object Structures
steps: steps:
(1) Check if the request can be met. If not, raise :c:data:`PyExc_BufferError`, (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. (2) Fill in the requested fields.
(3) Increment an internal counter for the number of exports. (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``. (5) Return ``0``.
@ -2370,10 +2370,10 @@ Buffer Object Structures
schemes can be used: schemes can be used:
* Re-export: Each member of the tree acts as the exporting object and * 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 * 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. object.
The individual fields of *view* are described in section The individual fields of *view* are described in section
@ -2415,7 +2415,7 @@ Buffer Object Structures
*view* argument. *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 done automatically in :c:func:`PyBuffer_Release` (this scheme is
useful for breaking reference cycles). useful for breaking reference cycles).