summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-01-28 17:23:05 (GMT)
committerFred Drake <fdrake@acm.org>2001-01-28 17:23:05 (GMT)
commitc37f5b3296253b460fc3666a0d3a7df2fb3bf2b6 (patch)
treee795314647bb00a84ac5e30dc58af363a5a6ae62
parentb4cd5c1a3aa11a7b7a180fe1d241968392ab8e33 (diff)
downloadcpython-c37f5b3296253b460fc3666a0d3a7df2fb3bf2b6.zip
cpython-c37f5b3296253b460fc3666a0d3a7df2fb3bf2b6.tar.gz
cpython-c37f5b3296253b460fc3666a0d3a7df2fb3bf2b6.tar.bz2
Adjust documentation for new.instance() to reflect that the second
parameter may be omitted or None.
-rw-r--r--Doc/lib/libnew.tex8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/lib/libnew.tex b/Doc/lib/libnew.tex
index ec9bc11..9547b58 100644
--- a/Doc/lib/libnew.tex
+++ b/Doc/lib/libnew.tex
@@ -14,10 +14,12 @@ to the interpreter, so care must be exercised when using this module.
The \module{new} module defines the following functions:
-\begin{funcdesc}{instance}{class, dict}
+\begin{funcdesc}{instance}{class\optional{, dict}}
This function creates an instance of \var{class} with dictionary
-\var{dict} without calling the \method{__init__()} constructor. Note that
-there are no guarantees that the object will be in a consistent state.
+\var{dict} without calling the \method{__init__()} constructor. If
+\var{dict} is omitted or \code{None}, a new, empty dictionary is
+created for the new instance. Note that there are no guarantees that
+the object will be in a consistent state.
\end{funcdesc}
\begin{funcdesc}{instancemethod}{function, instance, class}