]> granicus.if.org Git - python/commitdiff
Add a (very) simple description of PyType_Ready().
authorFred Drake <fdrake@acm.org>
Fri, 12 Apr 2002 16:15:10 +0000 (16:15 +0000)
committerFred Drake <fdrake@acm.org>
Fri, 12 Apr 2002 16:15:10 +0000 (16:15 +0000)
Doc/api/concrete.tex

index fd8ac4a8d6e712d68ed891f73280ccf7513d494f..f175ff12d7e1725ffd098d98a40a1330bb88e791 100644 (file)
@@ -75,6 +75,10 @@ This section describes Python type objects and the singleton object
 \end{cfuncdesc}
 
 \begin{cfuncdesc}{int}{PyType_Ready}{PyTypeObject *type}
+  Finalize a type object.  This should be called on all type objects
+  to finish their initialization.  This function is responsible for
+  adding inherited slots from a type's base class.  Returns \code{0}
+  on success, or returns \code{-1} and sets an exception on error.
   \versionadded{2.2}
 \end{cfuncdesc}