gh-136209: Add .. c:var:: declarations for C exception types#136210
gh-136209: Add .. c:var:: declarations for C exception types#136210encukou merged 11 commits intopython:mainfrom
Conversation
This info wasn't kept updated, and is of questionable value
|
I tried to do this before, but gave up when I saw that it was impossible to get rid of |
serhiy-storchaka
left a comment
There was a problem hiding this comment.
Is it possible to add space between three tables? Each table has certain order. When they are merged, there is no order.
We now can! We're using Sphinx 8.2 for 3.12+ (and 7.2 for 3.11): Line 10 in c45da6a |
Co-authored-by: Victor Stinner <vstinner@python.org>
|
But, I'm OK with this
I think it's only possible with three separate tables, with misaligned columns. |
vstinner
left a comment
There was a problem hiding this comment.
LGTM. I like the 3 tables. It's closer to the documentation of Python exceptions: https://docs.python.org/dev/library/exceptions.html (grouped by categories, as C API exceptions now).
I have no opinion on :no-typesetting:.
| :c:var:`!PyExc_WindowsError` is only defined on Windows; protect code that | ||
| uses this by testing that the preprocessor macro ``MS_WINDOWS`` is defined. | ||
|
|
||
|
|
There was a problem hiding this comment.
Maybe here is a better place for .. _standardwarningcategories:, no?
serhiy-storchaka
left a comment
There was a problem hiding this comment.
Thank you for your update.
I have no strong preference about the look of the definitions. Stable ABI notes has their value, although they are repetitive and take much space. We could add notes or a special column for the stable ABI version, but this will make the sources even larger. So I left this on you and other reviewers.
Three tables with separate subsection names look much better to me. If you want to align column widths, there is a ways to specify column widths explicitly.
|
Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13. |
|
Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14. |
…ythonGH-136210) (cherry picked from commit 85bc89f) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>
|
GH-136503 is a backport of this pull request to the 3.13 branch. |
…ythonGH-136210) (cherry picked from commit 85bc89f) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>
|
GH-136504 is a backport of this pull request to the 3.14 branch. |
…ythonGH-136210) Co-authored-by: Victor Stinner <vstinner@python.org>
…ythonGH-136210) Co-authored-by: Victor Stinner <vstinner@python.org>
…ythonGH-136210) Co-authored-by: Victor Stinner <vstinner@python.org>
…ythonGH-136210) Co-authored-by: Victor Stinner <vstinner@python.org>
…ythonGH-136210) Co-authored-by: Victor Stinner <vstinner@python.org>
…ypes (pythonGH-136210) (pythonGH-136504) (cherry picked from commit 85bc89f) Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>


.. c:var::declarations for C exception types. (This needs the type, and adds stable ABI declarations.)list-tableto avoid overlong linesnitpick_ignore📚 Documentation preview 📚: https://cpython-previews--136210.org.readthedocs.build/