]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Added description of optional parameter to UserDict constructor.
authorFred Drake <fdrake@acm.org>
Mon, 26 Jul 1999 15:45:52 +0000 (15:45 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 26 Jul 1999 15:45:52 +0000 (15:45 +0000)
Omission reported by Barry Warsaw.

Doc/lib/libuserdict.tex

index ce86ad26e08e836fdbe15069c2d405fc22220bf9..8e47360ec520ea5b44b499394497149430a6078e 100644 (file)
@@ -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