Document PyOS_CheckStack().

freddrake · freddrake · commit 17e6343d2d2c · 2000-08-31T05:50:40.000Z
Fix a couple of really minor markup nits.
diff --git a/Doc/api/api.tex b/Doc/api/api.tex
@@ -850,15 +850,16 @@ \chapter{Exception Handling \label{exceptionHandling}}
 temporarily.
 \end{cfuncdesc}
 
-\begin{cfuncdesc}{void}{PyErr_Restore}{PyObject *type, PyObject *value, PyObject *traceback}
+\begin{cfuncdesc}{void}{PyErr_Restore}{PyObject *type, PyObject *value,
+                                       PyObject *traceback}
 Set  the error indicator from the three objects.  If the error
 indicator is already set, it is cleared first.  If the objects are
 \NULL{}, the error indicator is cleared.  Do not pass a \NULL{} type
 and non-\NULL{} value or traceback.  The exception type should be a
 string or class; if it is a class, the value should be an instance of
 that class.  Do not pass an invalid exception type or value.
 (Violating these rules will cause subtle problems later.)  This call
-takes away a reference to each object, i.e. you must own a reference
+takes away a reference to each object, i.e.\ you must own a reference
 to each object before the call and after the call you no longer own
 these references.  (If you don't understand this, don't use this
 function.  I warned you.)  \strong{Note:}  This function is normally
@@ -1062,6 +1063,15 @@ \section{OS Utilities \label{os}}
 process, this function does not need to be called.
 \end{cfuncdesc}
 
+\begin{cfuncdesc}{int}{PyOS_CheckStack}{}
+Return true when the interpreter runs out of stack space.  This is a
+reliable check, but is only available when \code{USE_STACKCHECK} is
+defined (currently on Windows using the Microsoft Visual C++ compiler
+and on the Macintosh).  \code{USE_CHECKSTACK} will be defined
+automatically; you should never change the definition in your own
+code.
+\end{cfuncdesc}
+
 
 \section{Process Control \label{processControl}}
 
