]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607)
authorBrad Solomon <brad.solomon.1124@gmail.com>
Mon, 27 Apr 2020 02:31:44 +0000 (22:31 -0400)
committerGitHub <noreply@github.com>
Mon, 27 Apr 2020 02:31:44 +0000 (21:31 -0500)
commitb54e46cb57ebac5c525a9a6be241412cd57bc935
tree7dd9f94daebdc02c5f583a5ec3eaadee53d2c5b5
parenta494caa14bfa412af77792007c34274902fabb7b
bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607)

Adds a short description of `PyDoc_STRVAR` and `PyDoc_STR` to "Useful macros" section of C-API docs.

Currently, there is [one lone mention](https://docs.python.org/3/c-api/module.html?highlight=pydoc_strvar#c.PyModuleDef) in the C-API reference, despite the fact that `PyDoc_STRVAR` is ubiquitous to `Modules/`.

Additionally, this properly uses `c:macro` within `Doc/c-api/module.rst` to link.
Doc/c-api/intro.rst
Doc/c-api/module.rst
Misc/NEWS.d/next/Documentation/2019-10-06-23-44-15.bpo-38387.fZoq0S.rst [new file with mode: 0644]