This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Missing links to errnos on Built-in Exceptions page
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.10, Python 3.9, Python 3.8
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: JelleZijlstra, docs@python, eric.araujo, ezio.melotti, mdk, miss-islington, terry.reedy, willingc, yyyyyyyan
Priority: normal Keywords: patch

Created on 2020-07-07 22:39 by yyyyyyyan, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 21380 merged yyyyyyyan, 2020-07-07 22:47
PR 32316 merged miss-islington, 2022-04-05 02:01
PR 32317 merged miss-islington, 2022-04-05 02:01
Messages (9)
msg373260 - (view) Author: yyyyyyyan (yyyyyyyan) * Date: 2020-07-07 22:39
On the [Built-in Exceptions](https://docs.python.org/dev/library/exceptions.html) page, the exception [InterruptedError](https://docs.python.org/dev/library/exceptions.html#InterruptedError) correlates the error with the errno [EINTR](https://docs.python.org/dev/library/errno.html#errno.EINTR), linking the name `EINTR` with the errno page. This is great, since reading "*corresponds to errno EINTR*" is pointless if you don't know what `EINTR` means. The problem is `InterruptedError` is the only exception that put a link on the errno. All others only have the "correspondes to errno `ERRNO`", without any links, which makes it harder to understand.

The same thing happens on the [errno](https://docs.python.org/dev/library/errno.html). On the section about [errno.EINTR](https://docs.python.org/dev/library/errno.html#errno.EINTR) we have a "see also" box saying "This error is mapped to the exception InterruptedError", with a link to the InterruptedError section on the exceptions page. However, for some reason the "see also" box is only on this specific errno section.

The links should be added on both pages so the great pattern defined by `InterruptedError` and `errno.EINTR` is mantained.
msg373500 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2020-07-11 02:07
Only 3.8+ for bug fixes.
msg373537 - (view) Author: yyyyyyyan (yyyyyyyan) * Date: 2020-07-11 20:53
Thank you, @terry.reedy! Can you point me if this is defined in some written document I can check? Or is it an internal rule everyone kinda finds out by themselves?
msg373540 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2020-07-11 21:19
Near the bottom of the opening page: https://devguide.python.org/#status-of-python-branches
The meaning of 'status' is explained elsewhere.
msg373543 - (view) Author: yyyyyyyan (yyyyyyyan) * Date: 2020-07-11 23:28
Thank you so much! :-)
msg416714 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2022-04-05 02:01
New changeset a74892cb2168d249d9a8c53fad605a5def9b41d4 by yyyyyyyan in branch 'main':
bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380)
https://github.com/python/cpython/commit/a74892cb2168d249d9a8c53fad605a5def9b41d4
msg416715 - (view) Author: miss-islington (miss-islington) Date: 2022-04-05 02:30
New changeset 3fa800d7a7a405f51e0e8c9b7dac2f2a75c17bb4 by Miss Islington (bot) in branch '3.10':
bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380)
https://github.com/python/cpython/commit/3fa800d7a7a405f51e0e8c9b7dac2f2a75c17bb4
msg416716 - (view) Author: miss-islington (miss-islington) Date: 2022-04-05 02:30
New changeset e47e6ffed36eb1dd82da3bcadf8b45b894ef4ce2 by Miss Islington (bot) in branch '3.9':
bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380)
https://github.com/python/cpython/commit/e47e6ffed36eb1dd82da3bcadf8b45b894ef4ce2
msg416717 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2022-04-05 02:31
Thanks for the patch!
History
Date User Action Args
2022-04-11 14:59:33adminsetgithub: 85405
2022-04-05 02:31:04JelleZijlstrasetstatus: open -> closed
resolution: fixed
messages: + msg416717

stage: patch review -> resolved
2022-04-05 02:30:28miss-islingtonsetmessages: + msg416716
2022-04-05 02:30:14miss-islingtonsetmessages: + msg416715
2022-04-05 02:01:50miss-islingtonsetpull_requests: + pull_request30378
2022-04-05 02:01:45miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request30377
2022-04-05 02:01:40JelleZijlstrasetnosy: + JelleZijlstra
messages: + msg416714
2020-07-11 23:28:44yyyyyyyansetmessages: + msg373543
2020-07-11 21:19:23terry.reedysetmessages: + msg373540
2020-07-11 20:53:36yyyyyyyansetmessages: + msg373537
2020-07-11 02:07:38terry.reedysetnosy: + terry.reedy

messages: + msg373500
versions: - Python 3.5, Python 3.6, Python 3.7
2020-07-07 22:47:22yyyyyyyansetkeywords: + patch
stage: patch review
pull_requests: + pull_request20524
2020-07-07 22:39:26yyyyyyyancreate