From 7d5b8131b141cd029735f96f400f50fc5db865e0 Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Sun, 23 Mar 2025 13:18:32 +0100 Subject: [PATCH] [3.12] gh-121529: Document `from_` parameter in `_mboxMMDF` public methods (GH-121530) (#131622) gh-121529: Document `from_` parameter in `_mboxMMDF` public methods (GH-121530) (cherry picked from commit 557d2d20d484a7b22da39cdb876f6312ab66d561) Co-authored-by: Sebb --- Doc/library/mailbox.rst | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst index 6eb8dec44eb3..2c1c4b659fac 100644 --- a/Doc/library/mailbox.rst +++ b/Doc/library/mailbox.rst @@ -482,12 +482,27 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF. remarks: - .. method:: get_file(key) + .. method:: get_bytes(key, from_=False) + + Note: This method has an extra parameter (*from_*) compared with other classes. + The first line of an mbox file entry is the Unix "From " line. + If *from_* is False, the first line of the file is dropped. + + .. method:: get_file(key, from_=False) Using the file after calling :meth:`~Mailbox.flush` or :meth:`~Mailbox.close` on the :class:`!mbox` instance may yield unpredictable results or raise an exception. + Note: This method has an extra parameter (*from_*) compared with other classes. + The first line of an mbox file entry is the Unix "From " line. + If *from_* is False, the first line of the file is dropped. + + .. method:: get_string(key, from_=False) + + Note: This method has an extra parameter (*from_*) compared with other classes. + The first line of an mbox file entry is the Unix "From " line. + If *from_* is False, the first line of the file is dropped. .. method:: lock() unlock() @@ -742,12 +757,22 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF. remarks: - .. method:: get_file(key) + .. method:: get_bytes(key, from_=False) + + Note: This method has an extra parameter (*from_*) compared with other classes. + The first line of an mbox file entry is the Unix "From " line. + If *from_* is False, the first line of the file is dropped. + + .. method:: get_file(key, from_=False) Using the file after calling :meth:`~Mailbox.flush` or :meth:`~Mailbox.close` on the :class:`!MMDF` instance may yield unpredictable results or raise an exception. + Note: This method has an extra parameter (*from_*) compared with other classes. + The first line of an mbox file entry is the Unix "From " line. + If *from_* is False, the first line of the file is dropped. + .. method:: lock() unlock() -- 2.47.3