Skip to content

gh-121529: Document from_ parameter in _mboxMMDF methods#121530

Merged
picnixz merged 11 commits intopython:mainfrom
sebbASF:mbox-from
Mar 23, 2025
Merged

gh-121529: Document from_ parameter in _mboxMMDF methods#121530
picnixz merged 11 commits intopython:mainfrom
sebbASF:mbox-from

Conversation

@sebbASF
Copy link
Copy Markdown
Contributor

@sebbASF sebbASF commented Jul 9, 2024 •
edited by github-actions Bot
Loading

@sebbASF sebbASF requested a review from a team as a code owner July 9, 2024 11:16
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 9, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Jul 9, 2024
Closed
ZeroIntensity
ZeroIntensity requested changes Jul 9, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

ZeroIntensity
ZeroIntensity requested changes Jul 9, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

ZeroIntensity
ZeroIntensity requested changes Jul 9, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Member

ZeroIntensity commented Jul 9, 2024 •
edited
Loading

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

ZeroIntensity
ZeroIntensity approved these changes Jul 9, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@ZeroIntensity
Copy link
Copy Markdown
Member

ZeroIntensity commented Feb 23, 2025

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

@picnixz
Copy link
Copy Markdown
Member

picnixz commented Feb 23, 2025

I was just writing the commit message :')

@picnixz
Copy link
Copy Markdown
Member

picnixz commented Feb 23, 2025 •
edited
Loading

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 picnixz self-requested a review February 24, 2025 00:01
@picnixz
Copy link
Copy Markdown
Member

picnixz commented Feb 24, 2025

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

picnixz
picnixz reviewed Feb 24, 2025
View reviewed changes
Comment thread Doc/library/mailbox.rst
@picnixz picnixz self-assigned this Feb 24, 2025
@picnixz picnixz merged commit 557d2d2 into python:main Mar 23, 2025
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Mar 23, 2025
@picnixz picnixz added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 23, 2025
@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented Mar 23, 2025

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

@miss-islington-app
Copy link
Copy Markdown

miss-islington-app Bot commented Mar 23, 2025

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 23, 2025
@sebbASF @miss-islington
pythongh-121529: Document from_ parameter in _mboxMMDF public met…
87bd98c 
…hods (pythonGH-121530)

(cherry picked from commit 557d2d2)

Co-authored-by: Sebb <sebbASF@users.noreply.github.com>
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Mar 23, 2025

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label Mar 23, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 23, 2025
@sebbASF @miss-islington
pythongh-121529: Document from_ parameter in _mboxMMDF public met…
14faf0d 
…hods (pythonGH-121530)

(cherry picked from commit 557d2d2)

Co-authored-by: Sebb <sebbASF@users.noreply.github.com>
@bedevere-app
Copy link
Copy Markdown

bedevere-app Bot commented Mar 23, 2025

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Mar 23, 2025
picnixz pushed a commit that referenced this pull request Mar 23, 2025
@miss-islington @sebbASF
[3.13] gh-121529: Document from_ parameter in _mboxMMDF public me…
5e3f93a 
…thods (GH-121530) (#131623)

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

Co-authored-by: Sebb <sebbASF@users.noreply.github.com>
picnixz pushed a commit that referenced this pull request Mar 23, 2025
@miss-islington @sebbASF
[3.12] gh-121529: Document from_ parameter in _mboxMMDF public me…
7d5b813 
…thods (GH-121530) (#131622)

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

Co-authored-by: Sebb <sebbASF@users.noreply.github.com>
@sebbASF sebbASF deleted the mbox-from branch March 29, 2025 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixz picnixz picnixz left review comments

@ZeroIntensity ZeroIntensity ZeroIntensity approved these changes

Assignees

@picnixz picnixz

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sebbASF @ZeroIntensity @picnixz