Remove note that PyErr_SetInterrupt() is obsolete; add comment about the

fact that it was marked obsolete but is still needed.
Closes SF bug #919299.  Someone else should backport this to Python 2.3.
This commit is contained in:
Fred Drake 2004-03-25 14:25:28 +00:00
parent bc503d1e90
commit 85309512ec
1 changed files with 3 additions and 1 deletions

View File

@ -299,12 +299,14 @@ for each thread.
\end{cfuncdesc}
\begin{cfuncdesc}{void}{PyErr_SetInterrupt}{}
This function is obsolete. It simulates the effect of a
It simulates the effect of a
\constant{SIGINT}\ttindex{SIGINT} signal arriving --- the next time
\cfunction{PyErr_CheckSignals()} is called,
\withsubitem{(built-in exception)}{\ttindex{KeyboardInterrupt}}
\exception{KeyboardInterrupt} will be raised. It may be called
without holding the interpreter lock.
% XXX This was described as obsolete, but is used in
% thread.interrupt_main() (used from IDLE), so it's still needed.
\end{cfuncdesc}
\begin{cfuncdesc}{PyObject*}{PyErr_NewException}{char *name,