Commit 7bbd101b authored by Zachary Ware's avatar Zachary Ware

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.
parent 5ea5d2c3
...@@ -306,7 +306,7 @@ in various ways. There is a separate error indicator for each thread. ...@@ -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) .. 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. omitted.
...@@ -490,11 +490,11 @@ Exception Objects ...@@ -490,11 +490,11 @@ Exception Objects
reference, as accessible from Python through :attr:`__cause__`. 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 Set the cause associated with the exception to *cause*. Use *NULL* to clear
it. There is no type check to make sure that *ctx* is either an exception it. There is no type check to make sure that *cause* is either an exception
instance or :const:`None`. This steals a reference to *ctx*. instance or :const:`None`. This steals a reference to *cause*.
:attr:`__suppress_context__` is implicitly set to ``True`` by this function. :attr:`__suppress_context__` is implicitly set to ``True`` by this function.
......
...@@ -113,7 +113,7 @@ There are only a few functions special to module objects. ...@@ -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 Return a pointer to the :c:type:`PyModuleDef` struct from which the module was
created, or *NULL* if the module wasn't created with 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) .. c:function:: PyObject* PyState_FindModule(PyModuleDef *def)
......
...@@ -205,9 +205,8 @@ type objects) *must* have the :attr:`ob_size` field. ...@@ -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` 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` 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 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 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 occurred during the return ``-1`` and set an exception condition when an error occurs.
comparison.
It is possible that the :c:member:`~PyTypeObject.tp_print` field will be deprecated. In any case, 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 it is recommended not to define :c:member:`~PyTypeObject.tp_print`, but instead to rely on
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment