summaryrefslogtreecommitdiffstats
path: root/Misc
diff options
context:
space:
mode:
authorBrad Solomon <brad.solomon.1124@gmail.com>2020-04-27 02:31:44 (GMT)
committerGitHub <noreply@github.com>2020-04-27 02:31:44 (GMT)
commitb54e46cb57ebac5c525a9a6be241412cd57bc935 (patch)
tree7dd9f94daebdc02c5f583a5ec3eaadee53d2c5b5 /Misc
parenta494caa14bfa412af77792007c34274902fabb7b (diff)
downloadcpython-b54e46cb57ebac5c525a9a6be241412cd57bc935.zip
cpython-b54e46cb57ebac5c525a9a6be241412cd57bc935.tar.gz
cpython-b54e46cb57ebac5c525a9a6be241412cd57bc935.tar.bz2
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.
Diffstat (limited to 'Misc')
-rw-r--r--Misc/NEWS.d/next/Documentation/2019-10-06-23-44-15.bpo-38387.fZoq0S.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/Misc/NEWS.d/next/Documentation/2019-10-06-23-44-15.bpo-38387.fZoq0S.rst b/Misc/NEWS.d/next/Documentation/2019-10-06-23-44-15.bpo-38387.fZoq0S.rst
new file mode 100644
index 0000000..a678fe5
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2019-10-06-23-44-15.bpo-38387.fZoq0S.rst
@@ -0,0 +1 @@
+Document :c:macro:`PyDoc_STRVAR` macro in the C-API reference.