[Python-checkins] python/dist/src/Doc/api abstract.tex,1.11,1.12

fdrake@sourceforge.net fdrake@sourceforge.net
Mon, 15 Apr 2002 13:51:22 -0700


Update of /cvsroot/python/python/dist/src/Doc/api
In directory usw-pr-cvs1:/tmp/cvs-serv15983

Modified Files:
	abstract.tex 
Log Message:
Add documentation for PyObject_Call().
Note that PyObject_Size() is a synonym for PyObject_Length().
This closes SF patch #544330 (contributed by Thomas Heller).


Index: abstract.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/abstract.tex,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** abstract.tex	4 Apr 2002 04:10:36 -0000	1.11
--- abstract.tex	15 Apr 2002 20:51:19 -0000	1.12
***************
*** 173,176 ****
--- 173,191 ----
  
  
+ \begin{cfuncdesc}{PyObject*}{PyObject_Call}{PyObject *callable_object,
+                                             PyObject *args,
+                                             PyObject *kw}
+   Call a callable Python object \var{callable_object}, with arguments
+   given by the tuple \var{args}, and named arguments given by the
+   dictionary \var{kw}. If no named arguments are needed, \var{kw} may
+   be \NULL{}. \var{args} must not be \NULL{}, use an empty tuple if
+   no arguments are needed. Returns the result of the call on success,
+   or \NULL{} on failure.  This is the equivalent of the Python
+   expression \samp{apply(\var{callable_object}, \var{args}, \var{kw})}
+   or \samp{\var{callable_object}(*\var{args}, **\var{kw})}.
+   \bifuncindex{apply}
+ \end{cfuncdesc}
+ 
+ 
  \begin{cfuncdesc}{PyObject*}{PyObject_CallObject}{PyObject *callable_object,
                                                    PyObject *args}
***************
*** 262,265 ****
--- 277,281 ----
  
  \begin{cfuncdesc}{int}{PyObject_Length}{PyObject *o}
+ \cfuncline{int}{PyObject_Size}{PyObject *o}
    Return the length of object \var{o}.  If the object \var{o} provides
    both sequence and mapping protocols, the sequence length is