diff Doc/lib/libuserdict.tex @ 11140:cdfa9cd4e72b legacy-trunk

Added description of optional parameter to UserDict constructor. Omission reported by Barry Warsaw.
author Fred Drake <fdrake@acm.org>
date Mon, 26 Jul 1999 15:45:52 +0000
parents 76008f8a0e5f
children a216fe79ae00
line wrap: on
line diff
--- a/Doc/lib/libuserdict.tex	Fri Jul 23 16:11:36 1999 +0000
+++ b/Doc/lib/libuserdict.tex	Mon Jul 26 15:45:52 1999 +0000
@@ -12,10 +12,13 @@
 
 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