]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
[3.7] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607) ...
authorZachary Ware <zach@python.org>
Mon, 27 Apr 2020 02:46:06 +0000 (21:46 -0500)
committerGitHub <noreply@github.com>
Mon, 27 Apr 2020 02:46:06 +0000 (21:46 -0500)
commit70ba81459eeb5818848f86b65cdf78feb86f9612
treec382c61921025420b074dcd8f82f9be4402e5a79
parentfd32a0e2ee445dd7156323d216627112e66b0a69
[3.7] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607) (GH-19728)

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_strvarGH-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..
(cherry picked from commit b54e46cb57ebac5c525a9a6be241412cd57bc935)

Co-authored-by: Brad Solomon <brad.solomon.1124@gmail.com>
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]