missing module names in email package

[ggenellina]

BPO	1391608
Nosy	@freddrake, @warsaw

^{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/warsaw'
closed_at = <Date 2006-07-28.02:19:59.000>
created_at = <Date 2005-12-28.02:04:59.000>
labels = ['docs']
title = 'missing module names in email package'
updated_at = <Date 2006-07-28.02:19:59.000>
user = 'https://bugs.python.org/ggenellina'

bugs.python.org fields:

activity = <Date 2006-07-28.02:19:59.000>
actor = 'barry'
assignee = 'barry'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2005-12-28.02:04:59.000>
creator = 'ggenellina'
dependencies = []
files = []
hgrepos = []
issue_num = 1391608
keywords = []
message_count = 3.0
messages = ['27166', '27167', '27168']
nosy_count = 3.0
nosy_names = ['fdrake', 'barry', 'ggenellina']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue1391608'
versions = ['Python 2.5']

[ggenellina]

Documentation for modules inside the email package
lacks reference to module name in title (and body too).
By example, there is no clue in 12.2.1 that the Message
class being described is contained in the email.Message
module. Or 12.2.2 doesnt menction that FeedParser,
HeaderParser and Parser are all classes contained in
module email.Parser. And so on.

Looking at other similar standard packages (like
curses) seems that the module name should appear first
in the title.

[freddrake]

Logged In: YES
user_id=3066

Assigned to the email tsar. This is complicated by the
dual-naming approach for Python 2.5.

[warsaw]

Logged In: YES
user_id=12800

This is actually handled in Python 2.5 (email 4.0) much
better, and I don't plan on backporting this to Python 2.4
(email 3.0).