homepage

> Date: 2012年9月13日 00:28:20 -0700
> To: docs@python.org
> Subject: [docs] Bug in documentation for mailbox module
>
> I think I may have found a minor bug in the documentation for the
> mailbox module, at:
>
> http://docs.python.org/library/mailbox.html
>
> Right at the beginning of section 18.4.2. ("Message objects"), when
> describing the mailbox.Message class, is the following:
>
> "A subclass of the email.Message module?s *Message*. Subclasses of
> mailbox.Message add mailbox-format-specific state and behavior."
>
> The word "Message" indicated above with asterisks is a hyperlink to:
>
> http://docs.python.org/library/mailbox.html#mailbox.Message
>
> I think it should instead link to:
>
> http://docs.python.org/library/email.message.html#email.message.Message
(from: http://mail.python.org/pipermail/docs/2012-September/010520.html )

But the whole 18.4.2 is mount mailbox.Message so, it seems to be correct documentation. 
email.Message.Message is properly mentioned in the 4th line properly.
I don't think it is bug.

> But the whole 18.4.2 is mount mailbox.Message
But the first reference is a reference to email.Message's Message, so that word should link to email.Message.Message. Sphinx lets you to link to classes, etc. outside the current scope. It's a simple one word or so fix.

New changeset be94d100f846 by R David Murray in branch '3.2':
#16071: fix links to email.message.Message in mailbox docs.
http://hg.python.org/cpython/rev/be94d100f846
New changeset 2a14542371b7 by R David Murray in branch 'default':
Merge #16071: fix links to email.message.Message in mailbox docs.
http://hg.python.org/cpython/rev/2a14542371b7
New changeset 70af6b53b52a by R David Murray in branch '3.2':
#16071: fix more email.message links in mailbox docs.
http://hg.python.org/cpython/rev/70af6b53b52a
New changeset f3bd51cdd958 by R David Murray in branch 'default':
Merge #16071: fix more email.message links in mailbox docs.
http://hg.python.org/cpython/rev/f3bd51cdd958 

New changeset aad3cec524f9 by R David Murray in branch '2.7':
#16071: fix email.message links in the mailbox docs.
http://hg.python.org/cpython/rev/aad3cec524f9 

Two words and a tilde. But there were also a number of other places where the links were broken. Hopefully I caught them all.

http://docs.python.org/library/mailbox.html#mailbox.Message still points to mailbox.Message instead of email.Message "A subclass of the email.Message module’s {bad link}Message{/bad link}"
Not sure if this is a matter of changes that haven't yet been deployed, or just one that slipped through the cracks.

It can take up to 24 hours for the changes to show up on the web site. They are regenerated at least once per day.