From: Fred Drake <fdrake@acm.org>
Date: Fri, 12 Apr 2002 16:15:10 +0000 (+0000)
Subject: Add a (very) simple description of PyType_Ready().
X-Git-Tag: v2.3c1~6004
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=28de8d4b372ac6bf6adb305484b6e8a9bf21ca8f;p=thirdparty%2FPython%2Fcpython.git

Add a (very) simple description of PyType_Ready().
---

diff --git a/Doc/api/concrete.tex b/Doc/api/concrete.tex
index fd8ac4a8d6e7..f175ff12d7e1 100644
--- a/Doc/api/concrete.tex
+++ b/Doc/api/concrete.tex
@@ -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}