summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSkip Montanaro <skip@pobox.com>2003-01-21 01:53:09 (GMT)
committerSkip Montanaro <skip@pobox.com>2003-01-21 01:53:09 (GMT)
commitb3b22f3a299c6549724519be53cddff6734bcc1a (patch)
tree71f177ecc5dd405e9e38f7335bac9d3ffe2075ca
parent1f7a271f0b6d4fc8162cf81458cf1182e3bf65a8 (diff)
downloadcpython-b3b22f3a299c6549724519be53cddff6734bcc1a.zip
cpython-b3b22f3a299c6549724519be53cddff6734bcc1a.tar.gz
cpython-b3b22f3a299c6549724519be53cddff6734bcc1a.tar.bz2
flesh out open() docstring
-rw-r--r--Lib/shelve.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/Lib/shelve.py b/Lib/shelve.py
index 9477c5d..982c4e2 100644
--- a/Lib/shelve.py
+++ b/Lib/shelve.py
@@ -157,7 +157,13 @@ class DbfilenameShelf(Shelf):
def open(filename, flag='c', binary=False):
"""Open a persistent dictionary for reading and writing.
- Argument is the filename for the dbm database.
+ The filename parameter is the base filename for the underlying database.
+ As a side-effect, an extension may be added to the filename and more
+ than one file may be created. The optional flag parameter has the
+ same interpretation as the flag parameter of anydbm.open(). The
+ optional binary parameter may be set to True to force the use of binary
+ pickles for serializing data values.
+
See the module's __doc__ string for an overview of the interface.
"""