From: Raymond Hettinger <python@rcn.com>
Date: Wed, 10 Sep 2003 04:44:29 +0000 (+0000)
Subject: SF bug #802302:  Invalid documentation for dbhash.
X-Git-Tag: v2.4a1~1602
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0d6e8cde1a9470b12477096ea3e0560e9ccd2c58;p=python

SF bug #802302:  Invalid documentation for dbhash.

The documentation severely departed for the actual implementation.
---

diff --git a/Doc/lib/libdbhash.tex b/Doc/lib/libdbhash.tex
index 4b856de0b8..00a6d080bf 100644
--- a/Doc/lib/libdbhash.tex
+++ b/Doc/lib/libdbhash.tex
@@ -66,23 +66,22 @@ available in addition to the standard methods.
   begin a reverse-order traversal; see \method{previous()}.
 \end{methoddesc}
 
-\begin{methoddesc}[dbhash]{next}{key}
-  Returns the key that follows \var{key} in the traversal.  The
+\begin{methoddesc}[dbhash]{next}{}
+  Returns the key next key in a database traversal.  The
   following code prints every key in the database \code{db}, without
   having to create a list in memory that contains them all:
 
 \begin{verbatim}
-k = db.first()
-while k != None:
-    print k
-    k = db.next(k)
+print db.first()
+for i in xrange(1, len(d)):
+    print db.next()
 \end{verbatim}
 \end{methoddesc}
 
-\begin{methoddesc}[dbhash]{previous}{key}
-  Return the key that comes before \var{key} in a forward-traversal of 
-  the database.  In conjunction with \method{last()}, this may be used 
-  to implement a reverse-order traversal.
+\begin{methoddesc}[dbhash]{previous}{}
+  Returns the previous key in a forward-traversal of the database.
+  In conjunction with \method{last()}, this may be used to implement
+  a reverse-order traversal.
 \end{methoddesc}
 
 \begin{methoddesc}[dbhash]{sync}{}