summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorZachary Ware <zachary.ware@gmail.com>2014-02-26 16:40:38 (GMT)
committerZachary Ware <zachary.ware@gmail.com>2014-02-26 16:40:38 (GMT)
commit7bbd101bb18d7afb744f1cfa494187538d7c97c3 (patch)
tree2c5318a0c955363322230ffa786e6e7b153bc1f8 /Doc
parent5ea5d2c3f7ac3a308091bbbf11ab4f473571a628 (diff)
downloadcpython-7bbd101bb18d7afb744f1cfa494187538d7c97c3.zip
cpython-7bbd101bb18d7afb744f1cfa494187538d7c97c3.tar.gz
cpython-7bbd101bb18d7afb744f1cfa494187538d7c97c3.tar.bz2
Fix several C-API doc typos caught by tomo cocoa on docs@.
The signature and description of PyException_SetCause now use "cause" rather than "ctx" to match the code.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/exceptions.rst10
-rw-r--r--Doc/c-api/module.rst2
-rw-r--r--Doc/c-api/typeobj.rst5
3 files changed, 8 insertions, 9 deletions
diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst
index c3d978f..0aa892d 100644
--- a/Doc/c-api/exceptions.rst
+++ b/Doc/c-api/exceptions.rst
@@ -306,7 +306,7 @@ in various ways. There is a separate error indicator for each thread.
.. c:function:: void PyErr_SyntaxLocation(char *filename, int lineno)
- Like :c:func:`PyErr_SyntaxLocationExc`, but the col_offset parameter is
+ Like :c:func:`PyErr_SyntaxLocationEx`, but the col_offset parameter is
omitted.
@@ -490,11 +490,11 @@ Exception Objects
reference, as accessible from Python through :attr:`__cause__`.
-.. c:function:: void PyException_SetCause(PyObject *ex, PyObject *ctx)
+.. c:function:: void PyException_SetCause(PyObject *ex, PyObject *cause)
- Set the cause associated with the exception to *ctx*. Use *NULL* to clear
- it. There is no type check to make sure that *ctx* is either an exception
- instance or :const:`None`. This steals a reference to *ctx*.
+ Set the cause associated with the exception to *cause*. Use *NULL* to clear
+ it. There is no type check to make sure that *cause* is either an exception
+ instance or :const:`None`. This steals a reference to *cause*.
:attr:`__suppress_context__` is implicitly set to ``True`` by this function.
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst
index e80e0ea..bd46170 100644
--- a/Doc/c-api/module.rst
+++ b/Doc/c-api/module.rst
@@ -113,7 +113,7 @@ There are only a few functions special to module objects.
Return a pointer to the :c:type:`PyModuleDef` struct from which the module was
created, or *NULL* if the module wasn't created with
- :c:func:`PyModule_Create`.i
+ :c:func:`PyModule_Create`.
.. c:function:: PyObject* PyState_FindModule(PyModuleDef *def)
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index b2b8038..f3089d0 100644
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -205,9 +205,8 @@ type objects) *must* have the :attr:`ob_size` field.
bit currently defined is :const:`Py_PRINT_RAW`. When the :const:`Py_PRINT_RAW`
flag bit is set, the instance should be printed the same way as :c:member:`~PyTypeObject.tp_str`
would format it; when the :const:`Py_PRINT_RAW` flag bit is clear, the instance
- should be printed the same was as :c:member:`~PyTypeObject.tp_repr` would format it. It should
- return ``-1`` and set an exception condition when an error occurred during the
- comparison.
+ should be printed the same way as :c:member:`~PyTypeObject.tp_repr` would format it. It should
+ return ``-1`` and set an exception condition when an error occurs.
It is possible that the :c:member:`~PyTypeObject.tp_print` field will be deprecated. In any case,
it is recommended not to define :c:member:`~PyTypeObject.tp_print`, but instead to rely on