[Python-checkins] cpython (2.7): #16071: fix email.message links in the mailbox docs.
r.david.murray
python-checkins at python.org
Fri Sep 28 21:21:46 CEST 2012
http://hg.python.org/cpython/rev/aad3cec524f9
changeset: 79226:aad3cec524f9
branch: 2.7
parent: 79215:08aa289a757c
user: R David Murray <rdmurray at bitdance.com>
date: Fri Sep 28 15:21:32 2012 -0400
summary:
#16071: fix email.message links in the mailbox docs.
files:
Doc/library/mailbox.rst | 18 ++++++++++--------
1 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst
--- a/Doc/library/mailbox.rst
+++ b/Doc/library/mailbox.rst
@@ -11,8 +11,9 @@
This module defines two classes, :class:`Mailbox` and :class:`Message`, for
accessing and manipulating on-disk mailboxes and the messages they contain.
:class:`Mailbox` offers a dictionary-like mapping from keys to messages.
-:class:`Message` extends the :mod:`email.Message` module's :class:`Message`
-class with format-specific state and behavior. Supported mailbox formats are
+:class:`Message` extends the :mod:`email.message` module's
+:class:`~email.message.Message` class with format-specific state and behavior.
+Supported mailbox formats are
Maildir, mbox, MH, Babyl, and MMDF.
@@ -83,7 +84,7 @@
it.
Parameter *message* may be a :class:`Message` instance, an
- :class:`email.Message.Message` instance, a string, or a file-like object
+ :class:`email.message.Message` instance, a string, or a file-like object
(which should be open in text mode). If *message* is an instance of the
appropriate format-specific :class:`Message` subclass (e.g., if it's an
:class:`mboxMessage` instance and this is an :class:`mbox` instance), its
@@ -110,7 +111,7 @@
:exc:`KeyError` exception if no message already corresponds to *key*.
As with :meth:`add`, parameter *message* may be a :class:`Message`
- instance, an :class:`email.Message.Message` instance, a string, or a
+ instance, an :class:`email.message.Message` instance, a string, or a
file-like object (which should be open in text mode). If *message* is an
instance of the appropriate format-specific :class:`Message` subclass
(e.g., if it's an :class:`mboxMessage` instance and this is an
@@ -743,11 +744,12 @@
.. class:: Message([message])
- A subclass of the :mod:`email.Message` module's :class:`Message`. Subclasses of
- :class:`mailbox.Message` add mailbox-format-specific state and behavior.
+ A subclass of the :mod:`email.message` module's
+ :class:`~email.message.Message`. Subclasses of :class:`mailbox.Message` add
+ mailbox-format-specific state and behavior.
If *message* is omitted, the new instance is created in a default, empty state.
- If *message* is an :class:`email.Message.Message` instance, its contents are
+ If *message* is an :class:`email.message.Message` instance, its contents are
copied; furthermore, any format-specific information is converted insofar as
possible if *message* is a :class:`Message` instance. If *message* is a string
or a file, it should contain an :rfc:`2822`\ -compliant message, which is read
@@ -1251,7 +1253,7 @@
Set the message's visible headers to be the same as the headers in
*message*. Parameter *visible* should be a :class:`Message` instance, an
- :class:`email.Message.Message` instance, a string, or a file-like object
+ :class:`email.message.Message` instance, a string, or a file-like object
(which should be open in text mode).
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list