https://github.com/python/cpython/commit/2a300e36420f56383c6871d050ea74e525c7f590
commit: 2a300e36420f56383c6871d050ea74e525c7f590
branch: 3.13
author: Miss Islington (bot) <[email protected]>
committer: ZeroIntensity <[email protected]>
date: 2025-11-08T18:20:56Z
summary:

[3.13] gh-141004: Document the `PyDoc_VAR` macro (GH-141263) (GH-141265)

gh-141004: Document the `PyDoc_VAR` macro (GH-141263)
(cherry picked from commit 545299773b40fb589cbd5e54d1d597207d9a2a76)

Co-authored-by: Stan Ulbrych <[email protected]>

files:
M Doc/c-api/intro.rst

diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index 62ad5be7b8ac9f..b4a0fa74ffe030 100644
--- a/Doc/c-api/intro.rst
+++ b/Doc/c-api/intro.rst
@@ -247,7 +247,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
@@ -279,6 +279,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:
 

_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]

Reply via email to