From 5838d0fc846e2d601967e988f14c88b25d4d17ed Mon Sep 17 00:00:00 2001
From: Fred Drake <fdrake@acm.org>
Date: Sun, 28 Jan 2001 06:39:35 +0000
Subject: Document the PyInstance_*() functions and data.

---
 Doc/api/api.tex | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

(limited to 'Doc/api/api.tex')

diff --git a/Doc/api/api.tex b/Doc/api/api.tex
index 3d89adf821..03eebdf0a5 100644
--- a/Doc/api/api.tex
+++ b/Doc/api/api.tex
@@ -3694,6 +3694,36 @@ set.
 \end{cfuncdesc}
 
 
+\subsection{Instance Objects \label{instanceObjects}}
+
+\obindex{instance}
+There are very few functions specific to instance objects.
+
+\begin{cvardesc}{PyTypeObject}{PyInstance_Type}
+  Type object for class instances.
+\end{cvardesc}
+
+\begin{cfuncdesc}{int}{PyInstance_Check}{PyObject *obj}
+  Returns true if \var{obj} is an instance.
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{PyObject*}{PyInstance_New}{PyObject *class,
+                                             PyObject *arg,
+                                             PyObject *kw}
+  Create a new instance of a specific class.  The parameters \var{arg}
+  and \var{kw} are used as the positional and keyword parameters to
+  the object's constructor.
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{PyObject*}{PyInstance_NewRaw}{PyObject *class,
+                                                PyObject *dict}
+  Create a new instance of a specific class without calling it's
+  constructor.  \var{class} is the class of new object.  The
+  \var{dict} parameter will be used as the object's \member{__dict__};
+  if \NULL, a new dictionary will be created for the instance.
+\end{cfuncdesc}
+
+
 \subsection{Module Objects \label{moduleObjects}}
 
 \obindex{module}
@@ -4737,8 +4767,6 @@ Py_BuildValue
 
 DL_IMPORT
 
-Py*_Check
-
 _Py_NoneStruct
 
 
-- 
cgit v1.2.1

