From: Georg Brandl <georg@python.org>
Date: Thu, 25 Aug 2005 22:40:21 +0000 (+0000)
Subject: backport bug [ 1248199 ] shelve .sync operation not documented
X-Git-Tag: v2.4.2c1~68
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a74a655d816399e1168680c20daff3032665450d;p=thirdparty%2FPython%2Fcpython.git

backport bug [ 1248199 ] shelve .sync operation not documented
---

diff --git a/Doc/lib/libshelve.tex b/Doc/lib/libshelve.tex
index e369c2a97078..f17b82c2519f 100644
--- a/Doc/lib/libshelve.tex
+++ b/Doc/lib/libshelve.tex
@@ -43,6 +43,14 @@ Shelve objects support all methods supported by dictionaries.  This eases
 the transition from dictionary based scripts to those requiring persistent
 storage.
 
+One additional method is supported:
+\begin{methoddesc}[Shelf]{sync}{}
+Write back all entries in the cache if the shelf was opened with
+\var{writeback} set to \var{True}. Also empty the cache and synchronize
+the persistent dictionary on disk, if feasible.  This is called automatically
+when the shelf is closed with \method{close()}.
+\end{methoddesc}
+
 \subsection{Restrictions}
 
 \begin{itemize}