[New-bugs-announce] [issue35035] Documentation for email.utils is named email.util.rst

Zhiming Wang report at bugs.python.org
Sun Oct 21 02:17:19 EDT 2018


New submission from Zhiming Wang <zmwangx at gmail.com>:

Documentation for PSL module email.utils is named email.util.rst. See <https://docs.python.org/3/library/email.util.html>.

This seems to violate the principle of least surprise. (I have a command line tool to open documentation for any PSL module, and I found this name mismatch when I used that with email.utils.) It should be named email.utils.rst instead, unless there's a specific reason not to.

----------
assignee: docs at python
components: Documentation
messages: 328190
nosy: docs at python, zmwangx
priority: normal
severity: normal
status: open
title: Documentation for email.utils is named email.util.rst
versions: Python 3.7, Python 3.8

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


More information about the New-bugs-announce mailing list