traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
cpython/Doc/c-api
History
Zachary Ware ca5649c4c1
[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>
 		2020-04-26 21:45:05 -05:00
..
abstract.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
allocation.rst bpo-37432: Doc: Fix signature of PyObject_Del() (GH-14430) 2019-06-28 02:16:36 -07:00
apiabiversion.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
arg.rst Doc: int -> int or Py_ssize_t (GH-18663) 2020-02-25 22:11:16 -08:00
bool.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
buffer.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
bytearray.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
bytes.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
capsule.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
cell.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
code.rst Fix the miscellaneous typo (GH-17700) 2019-12-25 07:45:52 -08:00
codec.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
complex.rst bpo-20092. Use __index__ in constructors of int, float and complex. (GH-13108) 2019-06-02 00:05:48 +03:00
concrete.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
contextvars.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
conversion.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
coro.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
datetime.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
descriptor.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
dict.rst bpo-39153: Clarify C API *SetItem refcounting semantics (GH-18220) 2020-01-29 03:29:35 -08:00
exceptions.rst [3.8] Doc: Fix grammar in PyErr_ResourceWarning (GH-18879) (GH-18976) 2020-03-13 21:02:38 +05:30
file.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
float.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
function.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
gcsupport.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
gen.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
import.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
index.rst bpo-36763: Implement the PEP 587 (GH-13592) 2019-05-27 16:39:22 +02:00
init.rst bpo-39161: Document multi-phase init modules under Py_NewInterpreter() (GH-17896) 2020-01-09 04:27:35 -08:00
init_config.rst [3.8] bpo-39136: Fixed typos (GH-17720) 2019-12-28 19:05:15 -05:00
intro.rst [3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607) (GH-19727) 2020-04-26 21:45:05 -05:00
iter.rst Minor C API documentation improvements. (GH-17697) 2019-12-24 22:35:01 -06:00
iterator.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
list.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
long.rst PyLong_AsLongLong() docs should say 'long long' (GH-18082) (GH-18110) 2020-01-21 19:22:21 +00:00
mapping.rst bpo-39153: Clarify C API *SetItem refcounting semantics (GH-18220) 2020-01-29 03:29:35 -08:00
marshal.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
memory.rst fix(doc): set correct RST syntax for c:function (GH-18589) 2020-02-21 02:54:00 -08:00
memoryview.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
method.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
module.rst [3.8] bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (GH-16607) (GH-19727) 2020-04-26 21:45:05 -05:00
none.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
number.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
objbuffer.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
object.rst bpo-39973: Fix the docs for PyObject_GenericSetDict() (GH-19026) 2020-03-17 01:25:34 -07:00
objimpl.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
refcounting.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
reflection.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
sequence.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
set.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
slice.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
stable.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
structures.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00
sys.rst bpo-39008: Require Py_ssize_t for PySys_Audit formats rather than raise a deprecation warning (GH-17540) 2019-12-09 11:22:30 -08:00
tuple.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
type.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
typeobj.rst bpo-39778: Add clarification about tp_traverse and ownership (GH-18754) 2020-03-02 19:04:13 -08:00
unicode.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
utilities.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
veryhigh.rst [3.8] bpo-38600: NULL -> ``NULL``. (GH-17001) (GH-17003) 2019-10-30 22:44:55 +02:00
weakref.rst [3.8] bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) (GH-16999) 2019-10-30 21:36:33 +02:00