https://github.com/python/cpython/commit/545299773b40fb589cbd5e54d1d597207d9a2a76
commit: 545299773b40fb589cbd5e54d1d597207d9a2a76
branch: main
author: Stan Ulbrych <[email protected]>
committer: ZeroIntensity <[email protected]>
date: 2025-11-08T13:12:03-05:00
summary:
gh-141004: Document the `PyDoc_VAR` macro (GH-141263)
files:
M Doc/c-api/intro.rst
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index acce3dc215d157..4e7d1630ab3da6 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:
_______________________________________________
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]
