Minor C API documentation improvements. (GH-17697)

miss-islington · WillAyd · benjaminp · commit e9039f32b3e8 · 2019-12-24T22:35:01.000-06:00
The added parentheses around the PyIter_Next assignment suppress the following warning which gcc throws without: ``` warning: using the result of an assignment as a condition without parentheses [-Wparentheses] ``` The other change is a typo fix (cherry picked from commit 5c7ed75) Co-authored-by: William Ayd <william.ayd@icloud.com>
diff --git a/Doc/c-api/iter.rst b/Doc/c-api/iter.rst
@@ -29,7 +29,7 @@ something like this::
        /* propagate error */
    }
 
-   while (item = PyIter_Next(iterator)) {
+   while ((item = PyIter_Next(iterator))) {
        /* do something with item */
        ...
        /* release reference when done */
diff --git a/Doc/includes/custom.c b/Doc/includes/custom.c
@@ -37,7 +37,7 @@ PyInit_custom(void)
     Py_INCREF(&CustomType);
     if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {
         Py_DECREF(&CustomType);
-        PY_DECREF(m);
+        Py_DECREF(m);
         return NULL;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ something like this::`
`29`	`29`	`/* propagate error */`
`30`	`30`	`}`
`31`	`31`
`32`		`- while (item = PyIter_Next(iterator)) {`
	`32`	`+ while ((item = PyIter_Next(iterator))) {`
`33`	`33`	`/* do something with item */`
`34`	`34`	`...`
`35`	`35`	`/* release reference when done */`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ PyInit_custom(void)`
`37`	`37`	`Py_INCREF(&CustomType);`
`38`	`38`	`if (PyModule_AddObject(m, "Custom", (PyObject *) &CustomType) < 0) {`
`39`	`39`	`Py_DECREF(&CustomType);`
`40`		`- PY_DECREF(m);`
	`40`	`+ Py_DECREF(m);`
`41`	`41`	`return NULL;`
`42`	`42`	`}`
`43`	`43`