From: Georg Brandl <georg@python.org>
Date: Thu, 25 Aug 2005 22:40:16 +0000 (+0000)
Subject: bug [ 1248199 ] shelve .sync operation not documented
X-Git-Tag: v2.5a0~1448
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bd77da6dab9d41ef246febf54c7928ce4496dd49;p=python

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

diff --git a/Doc/lib/libshelve.tex b/Doc/lib/libshelve.tex
index 9e9f7fe6c4..8bd204e331 100644
--- a/Doc/lib/libshelve.tex
+++ b/Doc/lib/libshelve.tex
@@ -42,6 +42,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}