summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libuserdict.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-07-26 15:45:52 (GMT)
committerFred Drake <fdrake@acm.org>1999-07-26 15:45:52 (GMT)
commit8d21243c3e79ed1cd8fb25ec91c5c86c7db7b209 (patch)
treec21fd088c581bb998411a5d73d67e812ed046867 /Doc/lib/libuserdict.tex
parent7dcc69a9798ff95958170974389823fe4c4458a2 (diff)
downloadcpython-8d21243c3e79ed1cd8fb25ec91c5c86c7db7b209.zip
cpython-8d21243c3e79ed1cd8fb25ec91c5c86c7db7b209.tar.gz
cpython-8d21243c3e79ed1cd8fb25ec91c5c86c7db7b209.tar.bz2
Added description of optional parameter to UserDict constructor.
Omission reported by Barry Warsaw.
Diffstat (limited to 'Doc/lib/libuserdict.tex')
-rw-r--r--Doc/lib/libuserdict.tex7
1 files changed, 5 insertions, 2 deletions
diff --git a/Doc/lib/libuserdict.tex b/Doc/lib/libuserdict.tex
index ce86ad2..8e47360 100644
--- a/Doc/lib/libuserdict.tex
+++ b/Doc/lib/libuserdict.tex
@@ -12,10 +12,13 @@ can add new behaviours to dictionaries.
The \module{UserDict} module defines the \class{UserDict} class:
-\begin{classdesc}{UserDict}{}
+\begin{classdesc}{UserDict}{\optional{intialdata}}
Return a class instance that simulates a dictionary. The instance's
contents are kept in a regular dictionary, which is accessible via the
-\member{data} attribute of \class{UserDict} instances.
+\member{data} attribute of \class{UserDict} instances. If
+\var{initialdata} is provided, \member{data} is initialized with its
+contents; note that a reference to \var{initialdata} will not be kept,
+allowing it be used used for other purposes.
\end{classdesc}
In addition to supporting the methods and operations of mappings (see