summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2011-07-13 13:59:24 (GMT)
committerGeorg Brandl <georg@python.org>2011-07-13 13:59:24 (GMT)
commit325eb470b70bbd46e5fc9519336d969cf1b7802b (patch)
tree02ba1e1c21a6a227f5729db1289f0f9f098601b8 /Doc
parent34b2b263db8dce3c980ec2a5061da4b7cc3c9106 (diff)
downloadcpython-325eb470b70bbd46e5fc9519336d969cf1b7802b.zip
cpython-325eb470b70bbd46e5fc9519336d969cf1b7802b.tar.gz
cpython-325eb470b70bbd46e5fc9519336d969cf1b7802b.tar.bz2
Clarify that PyErr_NewException creates an exception *class*, not instance.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/exceptions.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index 4c946c1..6f13c80 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -354,10 +354,10 @@ in various ways. There is a separate error indicator for each thread.
.. c:function:: PyObject* PyErr_NewException(char *name, PyObject *base, PyObject *dict)
- This utility function creates and returns a new exception object. The *name*
+ This utility function creates and returns a new exception class. The *name*
argument must be the name of the new exception, a C string of the form
- ``module.class``. The *base* and *dict* arguments are normally *NULL*. This
- creates a class object derived from :exc:`Exception` (accessible in C as
+ ``module.classname``. The *base* and *dict* arguments are normally *NULL*.
+ This creates a class object derived from :exc:`Exception` (accessible in C as
:c:data:`PyExc_Exception`).
The :attr:`__module__` attribute of the new class is set to the first part (up