From: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Date: Sat, 8 Nov 2025 18:12:03 +0000 (+0000)
Subject: gh-141004: Document the `PyDoc_VAR` macro (GH-141263)
X-Git-Tag: v3.15.0a2~153
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=545299773b40fb589cbd5e54d1d597207d9a2a76;p=thirdparty%2FPython%2Fcpython.git

gh-141004: Document the `PyDoc_VAR` macro (GH-141263)
---

diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index acce3dc215d1..4e7d1630ab3d 100644
--- a/Doc/c-api/intro.rst
+++ b/Doc/c-api/intro.rst
@@ -235,7 +235,7 @@ complete listing.
 
 .. c:macro:: PyDoc_STRVAR(name, str)
 
-   Creates a variable with name ``name`` that can be used in docstrings.
+   Creates a variable with name *name* that can be used in docstrings.
    If Python is built without docstrings, the value will be empty.
 
    Use :c:macro:`PyDoc_STRVAR` for docstrings to support building
@@ -267,6 +267,15 @@ complete listing.
           {NULL, NULL}
       };
 
+.. c:macro:: PyDoc_VAR(name)
+
+   Declares a static character array variable with the given name *name*.
+
+   For example::
+
+      PyDoc_VAR(python_doc) = PyDoc_STR("A genus of constricting snakes in the Pythonidae family native "
+                                        "to the tropics and subtropics of the Eastern Hemisphere.");
+
 
 .. _api-objects: