Missing links to errnos on Built-in Exceptions page

[yyyyyyyan]

BPO	41233
Nosy	@terryjreedy, @ezio-melotti, @merwok, @willingc, @JelleZijlstra, @JulienPalard, @miss-islington, @yyyyyyyan
PRs	bpo-41233: Add links to errnos referenced in exceptions docs #21380 [3.10] bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380) #32316 [3.9] bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380) #32317

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2022-04-05.02:31:04.248>
created_at = <Date 2020-07-07.22:39:26.079>
labels = ['type-feature', '3.8', '3.9', '3.10', 'docs']
title = 'Missing links to errnos on Built-in Exceptions page'
updated_at = <Date 2022-04-05.02:31:04.248>
user = 'https://github.com/yyyyyyyan'

bugs.python.org fields:

activity = <Date 2022-04-05.02:31:04.248>
actor = 'JelleZijlstra'
assignee = 'docs@python'
closed = True
closed_date = <Date 2022-04-05.02:31:04.248>
closer = 'JelleZijlstra'
components = ['Documentation']
creation = <Date 2020-07-07.22:39:26.079>
creator = 'yyyyyyyan'
dependencies = []
files = []
hgrepos = []
issue_num = 41233
keywords = ['patch']
message_count = 9.0
messages = ['373260', '373500', '373537', '373540', '373543', '416714', '416715', '416716', '416717']
nosy_count = 9.0
nosy_names = ['terry.reedy', 'ezio.melotti', 'eric.araujo', 'docs@python', 'willingc', 'JelleZijlstra', 'mdk', 'miss-islington', 'yyyyyyyan']
pr_nums = ['21380', '32316', '32317']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue41233'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

[yyyyyyyan]

On the Built-in Exceptions page, the exception InterruptedError correlates the error with the 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. On the section about 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.

[terryjreedy]

Only 3.8+ for bug fixes.

[yyyyyyyan]

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?

[terryjreedy]

Near the bottom of the opening page: https://devguide.python.org/#status-of-python-branches
The meaning of 'status' is explained elsewhere.

[yyyyyyyan]

Thank you so much! :-)

[JelleZijlstra]

New changeset a74892c by yyyyyyyan in branch 'main':
bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380)
a74892c

[miss-islington]

New changeset 3fa800d by Miss Islington (bot) in branch '3.10':
bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380)
3fa800d

[miss-islington]

New changeset e47e6ff by Miss Islington (bot) in branch '3.9':
bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380)
e47e6ff

[JelleZijlstra]

Thanks for the patch!