https://github.com/python/cpython/commit/7d5b8131b141cd029735f96f400f50fc5db865e0
commit: 7d5b8131b141cd029735f96f400f50fc5db865e0
branch: 3.12
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: picnixz <10796600+picn...@users.noreply.github.com>
date: 2025-03-23T12:18:32Z
summary:
[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 <sebb...@users.noreply.github.com>
files:
M Doc/library/mailbox.rst
diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst
index 6eb8dec44eb34a..2c1c4b659faca2 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()
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
