email.mime incorrectly documented (or implemented)

[beazley]

BPO	4767
Nosy	@birkenfeld

^{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 = 'https://github.com/birkenfeld'
closed_at = <Date 2009-01-01.13:15:01.265>
created_at = <Date 2008-12-29.15:55:08.342>
labels = ['type-bug', 'docs']
title = 'email.mime incorrectly documented (or implemented)'
updated_at = <Date 2009-01-01.13:15:01.264>
user = 'https://bugs.python.org/beazley'

bugs.python.org fields:

activity = <Date 2009-01-01.13:15:01.264>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2009-01-01.13:15:01.265>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2008-12-29.15:55:08.342>
creator = 'beazley'
dependencies = []
files = []
hgrepos = []
issue_num = 4767
keywords = []
message_count = 2.0
messages = ['78458', '78709']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'beazley']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue4767'
versions = ['Python 3.0']

[beazley]

The documentation describes classes such as

email.mime.MIMEText()
email.mime.MIMEMultipart()
email.mime.MIMEApplication()
etc...

However, it's confusing because none of these classes are actually found
in email.mime.

Suggest either using the full proper name:

   email.mime.text.MIMEText()

Or just using the short name along with a note saying where it's found:

   MIMEText()
   Defined in email.mime.text.  Further description, blah, blah..

Note: These classes *are* defined in email.mime in Python 2.6.

[birkenfeld]

Thanks, fixed in r68127.