Skip to content

gh-141004: Document the PyDoc_VAR macro #141263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 8, 2025
+10 −1
Merged

gh-141004: Document the PyDoc_VAR macro #141263

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc81c54
Commit
StanFromIreland Nov 8, 2025
c2b35da
Move
StanFromIreland Nov 8, 2025
263f340
Add example
StanFromIreland Nov 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion Doc/c-api/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down
Loading