summaryrefslogtreecommitdiffstats
path: root/Doc/api
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-10-24 20:54:18 (GMT)
committerFred Drake <fdrake@acm.org>2002-10-24 20:54:18 (GMT)
commit5e96f1ff1d21a018cb175ccadc4ab8edb9983eef (patch)
tree8c66d559f15c645e954277a3484f11562289ab1f /Doc/api
parent7b0255153f2402d9853b29cc7bd4ea1dce14a997 (diff)
downloadcpython-5e96f1ff1d21a018cb175ccadc4ab8edb9983eef.zip
cpython-5e96f1ff1d21a018cb175ccadc4ab8edb9983eef.tar.gz
cpython-5e96f1ff1d21a018cb175ccadc4ab8edb9983eef.tar.bz2
Correct the description of PyErr_Restore().
Closes SF bug #577000.
Diffstat (limited to 'Doc/api')
-rw-r--r--Doc/api/exceptions.tex6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/api/exceptions.tex b/Doc/api/exceptions.tex
index 6163666..d6c6c7b 100644
--- a/Doc/api/exceptions.tex
+++ b/Doc/api/exceptions.tex
@@ -102,15 +102,15 @@ for each thread.
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.
+ string or 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: 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.) \note{This function is normally only used
by code that needs to save and restore the error indicator
- temporarily.}
+ temporarily; use \cfunction{PyErr_Fetch()} to save the current
+ exception state.}
\end{cfuncdesc}
\begin{cfuncdesc}{void}{PyErr_SetString}{PyObject *type, char *message}