Skip to content

[3.13] gh-121529: Document from_ parameter in _mboxMMDF public methods (GH-121530) #131623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 23, 2025
Merged

[3.13] gh-121529: Document from_ parameter in _mboxMMDF public methods (GH-121530) #131623

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions Doc/library/mailbox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,12 +587,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()
Expand Down Expand Up @@ -851,12 +866,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()
Expand Down
Loading