Skip to content

Incorrect footnotes at https://docs.python.org/3/c-api/exceptions.html#standard-exceptions #92431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
anntzer opened this issue May 7, 2022 · 2 comments
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@anntzer
Copy link
Contributor

anntzer commented May 7, 2022

Documentation

As of Python 3.10.4, the "Standard Exceptions" table has the following entries with footnotes:

  • PyExc_ReferenceError : ReferenceError : (2)
  • PyExc_WindowsError : (alias for PyExc_OSError) : (3)

but there is no footnote 3 and footnote 2 reads
"Only defined on Windows; protect code that uses this by testing that the preprocessor macro MS_WINDOWS is defined."

(As a related side point, the documentation for PyErr_SetFromWindowsErr (on the same page) refers to WindowsError and PyExc_WindowsError, but perhaps these should be updated to OSError and PyExc_OSError instead.)

@anntzer anntzer added the docs Documentation in the Doc dir label May 7, 2022
@hugovk
Copy link
Member

hugovk commented May 7, 2022

Footnotes in 3.10:

  1. This is a base class for other standard exceptions.
  2. Only defined on Windows; protect code that uses this by testing that the preprocessor macro MS_WINDOWS is defined.

Footnote 3 last seen in 3.6:

  1. This is a base class for other standard exceptions.
  2. This is the same as weakref.ReferenceError.
  3. Only defined on Windows; protect code that uses this by testing that the preprocessor macro MS_WINDOWS is defined.

And footnote 2 was deleted in #18452.

@hugovk
Copy link
Member

hugovk commented May 7, 2022

Thanks for the report, please see PR #92432.

@hugovk hugovk added the type-bug An unexpected behavior, bug, or error label May 7, 2022
serhiy-storchaka pushed a commit that referenced this issue May 8, 2022
* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 8, 2022
…2432)

* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54)

Co-authored-by: Hugo van Kemenade <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 8, 2022
…2432)

* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54)

Co-authored-by: Hugo van Kemenade <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 8, 2022
…2432)

* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54)

Co-authored-by: Hugo van Kemenade <[email protected]>
miss-islington added a commit that referenced this issue May 8, 2022
…H-92471)

* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54)


Co-authored-by: Hugo van Kemenade <[email protected]>

Automerge-Triggered-By: GH:serhiy-storchaka
miss-islington added a commit that referenced this issue May 8, 2022
…GH-92470)

* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54)


Co-authored-by: Hugo van Kemenade <[email protected]>

Automerge-Triggered-By: GH:serhiy-storchaka
miss-islington added a commit that referenced this issue May 8, 2022
…GH-92469)

* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54)


Co-authored-by: Hugo van Kemenade <[email protected]>

Automerge-Triggered-By: GH:serhiy-storchaka
hello-adam pushed a commit to hello-adam/cpython that referenced this issue Jun 2, 2022
…onGH-92432) (pythonGH-92471)

* Remove redundant footnote ref: the footnote has been removed
* Fix footnote ref to match footnote
* Convert footnotes into reST footnotes: will error if missing
(cherry picked from commit 788ef54)


Co-authored-by: Hugo van Kemenade <[email protected]>

Automerge-Triggered-By: GH:serhiy-storchaka
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

3 participants