[New-bugs-announce] [issue41233] Missing links to errnos on Built-in Exceptions page

yyyyyyyan report at bugs.python.org
Tue Jul 7 18:39:26 EDT 2020


New submission from yyyyyyyan <yanorestes at hotmail.com>:

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.

----------
assignee: docs at python
components: Documentation
messages: 373260
nosy: docs at python, eric.araujo, ezio.melotti, mdk, willingc, yyyyyyyan
priority: normal
severity: normal
status: open
title: Missing links to errnos on Built-in Exceptions page
type: enhancement
versions: Python 3.10, Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue41233>
_______________________________________


More information about the New-bugs-announce mailing list