diff options
| author | Brad Solomon <brad.solomon.1124@gmail.com> | 2020-04-27 02:31:44 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-27 02:31:44 (GMT) |
| commit | b54e46cb57ebac5c525a9a6be241412cd57bc935 (patch) | |
| tree | 7dd9f94daebdc02c5f583a5ec3eaadee53d2c5b5 /Doc/c-api/module.rst | |
| parent | a494caa14bfa412af77792007c34274902fabb7b (diff) | |
| download | cpython-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 'Doc/c-api/module.rst')
| -rw-r--r-- | Doc/c-api/module.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst index cf1df28..8a415df 100644 --- a/Doc/c-api/module.rst +++ b/Doc/c-api/module.rst @@ -153,7 +153,7 @@ or request "multi-phase initialization" by returning the definition struct itsel .. c:member:: const char *m_doc Docstring for the module; usually a docstring variable created with - :c:func:`PyDoc_STRVAR` is used. + :c:macro:`PyDoc_STRVAR` is used. .. c:member:: Py_ssize_t m_size |