Commit 66ded524 authored by Fred Drake's avatar Fred Drake

apply() documentation: Remove a detail about the implementation that does

not affect the API.  Clean up the text about call syntax apply() is
equivalent to.  Based on comments by Thomas Guettler.
parent 6f0699bc
...@@ -65,15 +65,16 @@ def my_import(name): ...@@ -65,15 +65,16 @@ def my_import(name):
\begin{funcdesc}{apply}{function, args\optional{, keywords}} \begin{funcdesc}{apply}{function, args\optional{, keywords}}
The \var{function} argument must be a callable object (a The \var{function} argument must be a callable object (a
user-defined or built-in function or method, or a class object) and user-defined or built-in function or method, or a class object) and
the \var{args} argument must be a sequence (if it is not a tuple, the \var{args} argument must be a sequence. The \var{function} is
the sequence is first converted to a tuple). The \var{function} is
called with \var{args} as the argument list; the number of arguments called with \var{args} as the argument list; the number of arguments
is the the length of the tuple. (This is different from just is the the length of the tuple.
calling \code{\var{func}(\var{args})}, since in that case there is
always exactly one argument.)
If the optional \var{keywords} argument is present, it must be a If the optional \var{keywords} argument is present, it must be a
dictionary whose keys are strings. It specifies keyword arguments dictionary whose keys are strings. It specifies keyword arguments
to be added to the end of the the argument list. to be added to the end of the the argument list.
Calling \function{apply()} is different from just calling
\code{\var{func}(\var{args})}, since in that case there is always
exactly one argument. The use of \function{apply()} is equivalent
to \code{\var{function}(*\var{args}, **\var{keywords})}.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}} \begin{funcdesc}{buffer}{object\optional{, offset\optional{, size}}}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment