Patch #702933: Undocument PyObject_NEW, PyObject_NEW_VAR,

and PyObject_DEL.
This commit is contained in:
Martin v. Löwis 2006-04-14 15:58:03 +00:00
parent b17f12bbc6
commit 82972e7f01
2 changed files with 1 additions and 20 deletions

View File

@ -195,9 +195,7 @@ free(buf1); /* Fatal -- should be PyMem_Del() */
In addition to the functions aimed at handling raw memory blocks from In addition to the functions aimed at handling raw memory blocks from
the Python heap, objects in Python are allocated and released with the Python heap, objects in Python are allocated and released with
\cfunction{PyObject_New()}, \cfunction{PyObject_NewVar()} and \cfunction{PyObject_New()}, \cfunction{PyObject_NewVar()} and
\cfunction{PyObject_Del()}, or with their corresponding macros \cfunction{PyObject_Del()}.
\cfunction{PyObject_NEW()}, \cfunction{PyObject_NEW_VAR()} and
\cfunction{PyObject_DEL()}.
These will be explained in the next chapter on defining and These will be explained in the next chapter on defining and
implementing new object types in C. implementing new object types in C.

View File

@ -62,23 +62,6 @@ defining new object types.
after this call as the memory is no longer a valid Python object. after this call as the memory is no longer a valid Python object.
\end{cfuncdesc} \end{cfuncdesc}
\begin{cfuncdesc}{\var{TYPE}*}{PyObject_NEW}{TYPE, PyTypeObject *type}
Macro version of \cfunction{PyObject_New()}, to gain performance at
the expense of safety. This does not check \var{type} for a \NULL{}
value.
\end{cfuncdesc}
\begin{cfuncdesc}{\var{TYPE}*}{PyObject_NEW_VAR}{TYPE, PyTypeObject *type,
Py_ssize_t size}
Macro version of \cfunction{PyObject_NewVar()}, to gain performance
at the expense of safety. This does not check \var{type} for a
\NULL{} value.
\end{cfuncdesc}
\begin{cfuncdesc}{void}{PyObject_DEL}{PyObject *op}
Macro version of \cfunction{PyObject_Del()}.
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{Py_InitModule}{char *name, \begin{cfuncdesc}{PyObject*}{Py_InitModule}{char *name,
PyMethodDef *methods} PyMethodDef *methods}
Create a new module object based on a name and table of functions, Create a new module object based on a name and table of functions,