summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2005-08-25 22:40:16 (GMT)
committerGeorg Brandl <georg@python.org>2005-08-25 22:40:16 (GMT)
commitbd77da6dab9d41ef246febf54c7928ce4496dd49 (patch)
treec8af1bab84215ad3ee7c1bd866c979669c5fd177 /Doc
parent905a01aba41988cb0c3d9fe15de38c3c94cc09dc (diff)
downloadcpython-bd77da6dab9d41ef246febf54c7928ce4496dd49.zip
cpython-bd77da6dab9d41ef246febf54c7928ce4496dd49.tar.gz
cpython-bd77da6dab9d41ef246febf54c7928ce4496dd49.tar.bz2
bug [ 1248199 ] shelve .sync operation not documented
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/libshelve.tex8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/lib/libshelve.tex b/Doc/lib/libshelve.tex
index 9e9f7fe..8bd204e 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}