diff options
| author | Serhiy Storchaka <storchaka@gmail.com> | 2013-08-19 06:59:18 (GMT) |
|---|---|---|
| committer | Serhiy Storchaka <storchaka@gmail.com> | 2013-08-19 06:59:18 (GMT) |
| commit | e0f0cf406757cea35db0aeaad592c2418d521b45 (patch) | |
| tree | f2b28faff6f7e583abc5251ddb19aa1c05da280e /Doc/library/email.iterators.rst | |
| parent | ca64d25dd285a784186bc16b3ee39ff8680cabdf (diff) | |
| download | cpython-e0f0cf406757cea35db0aeaad592c2418d521b45.zip cpython-e0f0cf406757cea35db0aeaad592c2418d521b45.tar.gz cpython-e0f0cf406757cea35db0aeaad592c2418d521b45.tar.bz2 | |
Issue #18761: Improved cross-references in email documentation.
Diffstat (limited to 'Doc/library/email.iterators.rst')
| -rw-r--r-- | Doc/library/email.iterators.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/Doc/library/email.iterators.rst b/Doc/library/email.iterators.rst index 7882718..f92f460 100644 --- a/Doc/library/email.iterators.rst +++ b/Doc/library/email.iterators.rst @@ -6,8 +6,9 @@ Iterating over a message object tree is fairly easy with the -:meth:`Message.walk` method. The :mod:`email.iterators` module provides some -useful higher level iterations over message object trees. +:meth:`Message.walk <email.message.Message.walk>` method. The +:mod:`email.iterators` module provides some useful higher level iterations over +message object trees. .. function:: body_line_iterator(msg, decode=False) @@ -16,9 +17,11 @@ useful higher level iterations over message object trees. string payloads line-by-line. It skips over all the subpart headers, and it skips over any subpart with a payload that isn't a Python string. This is somewhat equivalent to reading the flat text representation of the message from - a file using :meth:`readline`, skipping over all the intervening headers. + a file using :meth:`~io.TextIOBase.readline`, skipping over all the + intervening headers. - Optional *decode* is passed through to :meth:`Message.get_payload`. + Optional *decode* is passed through to :meth:`Message.get_payload + <email.message.Message.get_payload>`. .. function:: typed_subpart_iterator(msg, maintype='text', subtype=None) |