From: Raymond Hettinger <python@rcn.com>
Date: Sat, 13 Dec 2003 19:48:41 +0000 (+0000)
Subject: Note that \var{ppos} values are not consecutive and should not be altered.
X-Git-Tag: v2.4a1~1103
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5469324cdee92fd9454e42da737d12df5adb79ee;p=thirdparty%2FPython%2Fcpython.git

Note that \var{ppos} values are not consecutive and should not be altered.
---

diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index 67852dbbd3cf..c233ed4ed6d0 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -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: