]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
[3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607) ...
authorZachary Ware <zach@python.org>
Mon, 27 Apr 2020 02:45:05 +0000 (21:45 -0500)
committerGitHub <noreply@github.com>
Mon, 27 Apr 2020 02:45:05 +0000 (21:45 -0500)
commitca5649c4c1ab260c8ceb8a57ec703c06e2707986
tree03a8a707323c338f72f214a81d1337e80b387495
parent179f22c3b786ce9baa3445923f8f9708dfa5d5b7
[3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607) (GH-19727)

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 b54e46c)

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]