bpo-19225: Lack of c api exceptions doc#881
bpo-19225: Lack of c api exceptions doc#881serhiy-storchaka merged 7 commits intopython:masterfrom cocoatomo:lack-of-c-api-exceptions-doc
Conversation
|
@cocoatomo, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @DanielStutzbach and @benjaminp to be potential reviewers. |
| | :c:data:`PyExc_BaseException` | :exc:`BaseException` | \(1) | | ||
| +-----------------------------------------+---------------------------------+----------+ | ||
| | :c:data:`PyExc_Exception` | :exc:`Exception` | \(1) | | ||
| +-----------------------------------------+---------------------------------+----------+ |
There was a problem hiding this comment.
I feel BaseException and Exception are special enough to ignore alphabetical order.
There was a problem hiding this comment.
And the same is true for Warning.
| +-----------------------------------------+---------------------------------+----------+ | ||
| | :c:data:`PyExc_Exception` | :exc:`Exception` | \(1) | | ||
| +-----------------------------------------+---------------------------------+----------+ | ||
| | :c:data:`PyExc_ArithmeticError` | :exc:`ArithmeticError` | \(1) | |
There was a problem hiding this comment.
Since that are definitions of PyExc_* names, wouldn't be better to use the c:var directive?
.. c:var:: PyExc_ArithmeticError
Perhaps the index directive below will be not needed after that.
There was a problem hiding this comment.
I think this table is the most suitable place for definition of PyExc_* names.
I would fix these markup and delete index directives.
| | :c:data:`PyExc_BaseException` | :exc:`BaseException` | \(1) | | ||
| +-----------------------------------------+---------------------------------+----------+ | ||
| | :c:data:`PyExc_Exception` | :exc:`Exception` | \(1) | | ||
| +-----------------------------------------+---------------------------------+----------+ |
There was a problem hiding this comment.
And the same is true for Warning.
Doc/c-api/exceptions.rst
Outdated
| Notes: | ||
|
|
||
| (1) | ||
| This is a base class for other standard exceptions. |
There was a problem hiding this comment.
... for other standard warning categories.
|
Thanks for your good advisement. I updated the pull request. |
|
The tables will be really huge with the
|
|
Hmm, then it would be better to restore the variant with |
|
I changed |
|
@methane @serhiy-storchaka @MSeifert04 |
|
Move |
|
Thanks for your comment. |
…ames in C API doc (pythonGH-881) Move the `.. index` directive to more appropriate place. (cherry picked from commit e8c7631)
…ames in C API doc (pythonGH-881) Move the `.. index` directive to more appropriate place.. (cherry picked from commit e8c7631)
see bpo-19225.
I create this patch based on the patch created by Tamás Bence Gedai (beng94).