Skip to content

[3.7] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607)#19728

Merged
zware merged 1 commit intopython:3.7from
zware:backport-b54e46c-3.7
Apr 27, 2020
Merged

[3.7] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607)#19728
zware merged 1 commit intopython:3.7from
zware:backport-b54e46c-3.7

Conversation

@zware
Copy link
Member

@zware zware commented Apr 27, 2020

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

Currently, there is one lone mention 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

https://bugs.python.org/issue38387

…ythonGH-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_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)

Co-authored-by: Brad Solomon <brad.solomon.1124@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants