From 3fcc3ca54ef4ea59105222f19ee66070de84b542 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Date: Wed, 5 Oct 2022 00:18:09 +0100
Subject: [PATCH] gh-93738: Documentation C syntax (:c:data:`view->obj` ->
:c:expr:`view->obj`) (GH-97773)
:c:data:`view->obj` -> :c:expr:`view->obj`
(cherry picked from commit fa59bda8d30ea0b6c19007205b57c800c944304c)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
---
Doc/c-api/typeobj.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index 8be489ad1efc7c..7fa8fcecb68f82 100644
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -2321,13 +2321,13 @@ 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``.
@@ -2335,10 +2335,10 @@ Buffer Object Structures
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
@@ -2380,7 +2380,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).