Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(1)

Side by Side Diff: Doc/library/mailbox.rst

Issue 18758: Fix internal references in the documentation
Patch Set: Created 6 years, 5 months ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « Doc/library/itertools.rst ('k') | Doc/library/math.rst » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 :mod:`mailbox` --- Manipulate mailboxes in various formats 1 :mod:`mailbox` --- Manipulate mailboxes in various formats
2 ========================================================== 2 ==========================================================
3 3
4 .. module:: mailbox 4 .. module:: mailbox
5 :synopsis: Manipulate mailboxes in various formats 5 :synopsis: Manipulate mailboxes in various formats
6 .. moduleauthor:: Gregory K. Johnson <gkj@gregorykjohnson.com> 6 .. moduleauthor:: Gregory K. Johnson <gkj@gregorykjohnson.com>
7 .. sectionauthor:: Gregory K. Johnson <gkj@gregorykjohnson.com> 7 .. sectionauthor:: Gregory K. Johnson <gkj@gregorykjohnson.com>
8 8
9 9
10 This module defines two classes, :class:`Mailbox` and :class:`Message`, for 10 This module defines two classes, :class:`Mailbox` and :class:`Message`, for
(...skipping 991 matching lines...) Expand 10 before | Expand all | Expand 10 after
1002 Return a string representing the "From " line that marks the start of the 1002 Return a string representing the "From " line that marks the start of the
1003 message in an mbox mailbox. The leading "From " and the trailing newline 1003 message in an mbox mailbox. The leading "From " and the trailing newline
1004 are excluded. 1004 are excluded.
1005 1005
1006 1006
1007 .. method:: set_from(from_, time_=None) 1007 .. method:: set_from(from_, time_=None)
1008 1008
1009 Set the "From " line to *from_*, which should be specified without a 1009 Set the "From " line to *from_*, which should be specified without a
1010 leading "From " or trailing newline. For convenience, *time_* may be 1010 leading "From " or trailing newline. For convenience, *time_* may be
1011 specified and will be formatted appropriately and appended to *from_*. If 1011 specified and will be formatted appropriately and appended to *from_*. If
1012 *time_* is specified, it should be a :class:`struct_time` instance, a 1012 *time_* is specified, it should be a :class:`time.struct_time` instance, a
1013 tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use 1013 tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use
1014 :meth:`time.gmtime`). 1014 :meth:`time.gmtime`).
1015 1015
1016 1016
1017 .. method:: get_flags() 1017 .. method:: get_flags()
1018 1018
1019 Return a string specifying the flags that are currently set. If the 1019 Return a string specifying the flags that are currently set. If the
1020 message complies with the conventional format, the result is the 1020 message complies with the conventional format, the result is the
1021 concatenation in the following order of zero or one occurrence of each of 1021 concatenation in the following order of zero or one occurrence of each of
1022 ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. 1022 ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``.
(...skipping 350 matching lines...) Expand 10 before | Expand all | Expand 10 after
1373 Return a string representing the "From " line that marks the start of the 1373 Return a string representing the "From " line that marks the start of the
1374 message in an mbox mailbox. The leading "From " and the trailing newline 1374 message in an mbox mailbox. The leading "From " and the trailing newline
1375 are excluded. 1375 are excluded.
1376 1376
1377 1377
1378 .. method:: set_from(from_, time_=None) 1378 .. method:: set_from(from_, time_=None)
1379 1379
1380 Set the "From " line to *from_*, which should be specified without a 1380 Set the "From " line to *from_*, which should be specified without a
1381 leading "From " or trailing newline. For convenience, *time_* may be 1381 leading "From " or trailing newline. For convenience, *time_* may be
1382 specified and will be formatted appropriately and appended to *from_*. If 1382 specified and will be formatted appropriately and appended to *from_*. If
1383 *time_* is specified, it should be a :class:`struct_time` instance, a 1383 *time_* is specified, it should be a :class:`time.struct_time` instance, a
1384 tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use 1384 tuple suitable for passing to :meth:`time.strftime`, or ``True`` (to use
1385 :meth:`time.gmtime`). 1385 :meth:`time.gmtime`).
1386 1386
1387 1387
1388 .. method:: get_flags() 1388 .. method:: get_flags()
1389 1389
1390 Return a string specifying the flags that are currently set. If the 1390 Return a string specifying the flags that are currently set. If the
1391 message complies with the conventional format, the result is the 1391 message complies with the conventional format, the result is the
1392 concatenation in the following order of zero or one occurrence of each of 1392 concatenation in the following order of zero or one occurrence of each of
1393 ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``. 1393 ``'R'``, ``'O'``, ``'D'``, ``'F'``, and ``'A'``.
(...skipping 186 matching lines...) Expand 10 before | Expand all | Expand 10 after
1580 # Remove original message 1580 # Remove original message
1581 inbox.lock() 1581 inbox.lock()
1582 inbox.discard(key) 1582 inbox.discard(key)
1583 inbox.flush() 1583 inbox.flush()
1584 inbox.unlock() 1584 inbox.unlock()
1585 break # Found destination, so stop looking. 1585 break # Found destination, so stop looking.
1586 1586
1587 for box in boxes.itervalues(): 1587 for box in boxes.itervalues():
1588 box.close() 1588 box.close()
1589 1589
OLDNEW
« no previous file with comments | « Doc/library/itertools.rst ('k') | Doc/library/math.rst » ('j') | no next file with comments »

RSS Feeds Recent Issues | This issue
This is Rietveld 894c83f36cb7+