[Python-checkins] CVS: python/dist/src/Doc/api api.tex,1.97,1.98 refcounts.dat,1.18,1.19

Fred L. Drake python-dev@python.org
Tue, 28 Nov 2000 14:34:36 -0800


Update of /cvsroot/python/python/dist/src/Doc/api
In directory slayer.i.sourceforge.net:/tmp/cvs-serv1498/api

Modified Files:
	api.tex refcounts.dat 
Log Message:

Added documentation for the Py_InitModule*() family of functions.


Index: api.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/api.tex,v
retrieving revision 1.97
retrieving revision 1.98
diff -C2 -r1.97 -r1.98
*** api.tex	2000/10/23 16:00:54	1.97
--- api.tex	2000/11/28 22:34:32	1.98
***************
*** 4651,4655 ****
  \end{cfuncdesc}
  
! Py_InitModule (!!!)
  
  PyArg_ParseTupleAndKeywords, PyArg_ParseTuple, PyArg_Parse
--- 4651,4685 ----
  \end{cfuncdesc}
  
! \begin{cfuncdesc}{PyObject*}{Py_InitModule}{char *name,
!                                             PyMethodDef *methods}
!   Create a new module object based on a name and table of functions,
!   returning the new module object.
! \end{cfuncdesc}
! 
! \begin{cfuncdesc}{PyObject*}{Py_InitModule3}{char *name,
!                                              PyMethodDef *methods,
!                                              char *doc}
!   Create a new module object based on a name and table of functions,
!   returning the new module object.  If \var{doc} is non-\NULL, it will
!   be used to define the docstring for the module.
! \end{cfuncdesc}
! 
! \begin{cfuncdesc}{PyObject*}{Py_InitModule4}{char *name,
!                                              PyMethodDef *methods,
!                                              char *doc, PyObject *self,
!                                              int apiver}
!   Create a new module object based on a name and table of functions,
!   returning the new module object.  If \var{doc} is non-\NULL, it will
!   be used to define the docstring for the module.  If \var{self} is
!   non-\NULL, it will passed to the functions of the module as their
!   (otherwise \NULL) first parameter.  (This was added as an
!   experimental feature, and there are no known uses in the current
!   version of Python.)  For \var{apiver}, the only value which should
!   be passed is defined by the constant \constant{PYTHON_API_VERSION}.
! 
!   \strong{Note:}  Most uses of this function should probably be using
!   the \cfunction{Py_InitModule3()} instead; only use this if you are
!   sure you need it.
! \end{cfuncdesc}
  
  PyArg_ParseTupleAndKeywords, PyArg_ParseTuple, PyArg_Parse

Index: refcounts.dat
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/api/refcounts.dat,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -r1.18 -r1.19
*** refcounts.dat	2000/09/22 18:19:37	1.18
--- refcounts.dat	2000/11/28 22:34:32	1.19
***************
*** 275,278 ****
--- 275,294 ----
  PyFloat_FromDouble:double:v::
  
+ Py_InitModule:PyObject*::0:
+ Py_InitModule:name:char*::
+ Py_InitModule:methods:PyMethodDef[]::
+ 
+ Py_InitModule3:PyObject*::0:
+ Py_InitModule3:name:char*::
+ Py_InitModule3:methods:PyMethodDef[]::
+ Py_InitModule3:doc:char*::
+ 
+ Py_InitModule4:PyObject*::0:
+ Py_InitModule4:name:char*::
+ Py_InitModule4:methods:PyMethodDef[]::
+ Py_InitModule4:doc:char*::
+ Py_InitModule4:self:PyObject*::
+ Py_InitModule4:apiver:int::usually provided by Py_InitModule or Py_InitModule3
+ 
  PyImport_AddModule:PyObject*::0:reference borrowed from sys.modules
  PyImport_AddModule:char*:name::