New submission from Francois Labelle <quantum.om...@gmail.com>:

When mentioning the constants contained in the module email.charset, the 
documentation prefixes them with "Charset", for example: Charset.QP, 
Charset.BASE64, Charset.SHORTEST. This suggests that the constants can be found 
on the class "Charset" (uppercase first letter) in the module, while they are 
in fact contained in the the "charset" (lowercase first letter) module itself.

This is probably a left-over from when the module was called email.Charset (in 
2.2 I believe). Under Python 2.7, while the documentation uses the same 
nomenclature, at least the module is also importable under the name 
email.Charset so it makes more sense.

----------
assignee: docs@python
components: Documentation
messages: 316327
nosy: Francois Labelle, docs@python
priority: normal
severity: normal
status: open
title: Documentation for email.charset confusing about the location of constants
type: enhancement
versions: Python 2.7, Python 3.4, Python 3.5, Python 3.6, Python 3.7, Python 3.8

_______________________________________
Python tracker <rep...@bugs.python.org>
<https://bugs.python.org/issue33449>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to