mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 16:39:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

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

Browse source 
gh-121529: Document `from_` parameter in `_mboxMMDF` public methods (GH-121530)
(cherry picked from commit 557d2d20d4)

Co-authored-by: Sebb <sebbASF@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2025-03-23 13:17:37 +01:00 • committed by GitHub
parent 856bb54235
commit 5e3f93a8d7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 27 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

29
Doc/library/mailbox.rst
View file

@ -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()
@ -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()