]> granicus.if.org Git - python/commitdiff
Note that \var{ppos} values are not consecutive and should not be altered.
authorRaymond Hettinger <python@rcn.com>
Sat, 13 Dec 2003 19:48:41 +0000 (19:48 +0000)
committerRaymond Hettinger <python@rcn.com>
Sat, 13 Dec 2003 19:48:41 +0000 (19:48 +0000)
Doc/api/concrete.tex

index 67852dbbd3cf2d5c64cd45bca3533ab09e6757ba..c233ed4ed6d0361f7ab219cc6b116d39a52c9ee2 100644 (file)
@@ -1896,7 +1896,9 @@ format.
   parameters \var{pkey} and \var{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.
+  them are borrowed.  \var{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: