gh-121529: Document from_ parameter in _mboxMMDF methods

[sebbASF]

• Issue: Undocumented from_ parameter in _mboxMMDF methods #121529

---

📚 Documentation preview 📚: https://cpython-previews--121530.org.readthedocs.build/

[ZeroIntensity]

from_ should be italic, as *from_* in the file.

[ZeroIntensity]

Thanks! "unix" is a proper noun, it should be capitalized.

[ZeroIntensity]

Looks good to me, but I think 'From ' should use double quotes, as that's what's used in the docs already (see here, for example)

[ZeroIntensity]

Sorry for not catching the other two changes in my initial review, that's my fault.

[ZeroIntensity]

LGTM, I'll leave nitpicking the rest to someone else.

[ZeroIntensity]

@picnixz Here's an easy review in the backlog if you want to take a look. (This predates both of our triage memberships 😆.)

[picnixz]

I was just writing the commit message :')

[picnixz]

Actually, I've just observed that the documentation is not updating the paragraph for the MMDF class (https://cpython-previews--121530.org.readthedocs.build/en/121530/library/mailbox.html#mailbox.MMDF), only the paragraph for mailbox.mbox. Can this also be done in this PR? @sebbASF (see

cpython/Lib/mailbox.py

Line 947 in 1e4a434

class MMDF(_mboxMMDF):

which shows that mailbox.MMDF also inherits the same interface)

The commit title will be

gh-121529: Document `from_` parameter of `mailbox.mbox and `mailbox.MMDF` methods (#121530)

The commit message will be

In addition to documenting the `from_` parameter of the `mailbox.{mbox,MMDF}.get_file` method,
we also document the `get_bytes` and `get_string` methods that were previously not documented.

[picnixz]

I'll review it tomorrow and merge it if it's fine. Thanks for updating those docs btw

[miss-islington-app]

Thanks @sebbASF for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

[miss-islington-app]

Thanks @sebbASF for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

[bedevere-app]

GH-131622 is a backport of this pull request to the 3.12 branch.

[bedevere-app]

GH-131623 is a backport of this pull request to the 3.13 branch.