FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.14] gh-141004: Document the `PyDoc_VAR` macro (GH-141263) by miss-islington · Pull Request #141264 · python/cpython · GitHub

/ cpython Public

[3.14] gh-141004: Document the PyDoc_VAR macro (GH-141263) #141264

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
ZeroIntensity merged 1 commit into from
Nov 8, 2025
Conversation 0 Commits 1 Checks 33 Files changed
Merged

[3.14] gh-141004: Document the PyDoc_VAR macro (GH-141263) #141264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
11 changes: 10 additions & 1 deletion Doc/c-api/intro.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
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
Back | FazBrowse Home | New Git URL