diff options
Diffstat (limited to 'Doc/c-api/dict.rst')
| -rw-r--r-- | Doc/c-api/dict.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Doc/c-api/dict.rst b/Doc/c-api/dict.rst index 6f6705b..1dbeffa 100644 --- a/Doc/c-api/dict.rst +++ b/Doc/c-api/dict.rst @@ -146,16 +146,16 @@ Dictionary Objects .. cfunction:: int PyDict_Next(PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue) - Iterate over all key-value pairs in the dictionary *p*. The :ctype:`Py_ssize_t` - referred to by *ppos* must be initialized to ``0`` prior to the first call - to this function to start the iteration; the function returns true for each - pair in the dictionary, and false once all pairs have been reported. The - parameters *pkey* and *pvalue* should either point to :ctype:`PyObject\*` - variables that will be filled in with each key and value, respectively, or - may be *NULL*. Any references returned through them are borrowed. *ppos* - should not be altered during iteration. Its value represents offsets within - the internal dictionary structure, and since the structure is sparse, the - offsets are not consecutive. + Iterate over all key-value pairs in the dictionary *p*. The + :ctype:`Py_ssize_t` referred to by *ppos* must be initialized to ``0`` + prior to the first call to this function to start the iteration; the + function returns true for each pair in the dictionary, and false once all + pairs have been reported. The parameters *pkey* and *pvalue* should either + point to :ctype:`PyObject\*` variables that will be filled in with each key + and value, respectively, or may be *NULL*. Any references returned through + them are borrowed. *ppos* should not be altered during iteration. Its + value represents offsets within the internal dictionary structure, and + since the structure is sparse, the offsets are not consecutive. For example:: |