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

Created on 2020-07-07 22:39 by yyyyyyyan, last changed 2020-07-11 23:28 by yyyyyyyan.

Pull Requests
URL Status Linked Edit
PR 21380 open yyyyyyyan, 2020-07-07 22:47
Messages (5)
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! :-)
History
Date User Action Args
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