Skip to content

bpo-31538: Clarify the mailbox factory default #26776

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cryvate
Copy link
Contributor

@cryvate cryvate commented Jun 17, 2021

Basically, the mailbox factory default (and one of two subclasses) is not the same as passing the representation (class) that it returns to the factory (basically it does some extra processing).

No news entry required.

https://bugs.python.org/issue31538

@cryvate cryvate requested a review from a team as a code owner June 17, 2021 19:43
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels Jun 17, 2021
@github-actions
Copy link

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale Stale PR or inactive for long period of time. label Jul 18, 2021
@MaxwellDupre
Copy link
Contributor

I agree with you that is a problem and what you have added only deepens the issue and readers may want to know more so I think it would be a good idea to add your example.

@@ -447,8 +447,9 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF.
is a callable object that accepts a file-like message representation (which
behaves as if opened in binary mode) and returns a custom representation. If
*factory* is ``None``, :class:`mboxMessage` is used as the default message
representation. If *create* is ``True``, the mailbox is created if it does not
exist.
representation (but this is not the same as setting *factory* to
Copy link
Member

Choose a reason for hiding this comment

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

If it's not the same, then what is the difference? I saw the example in the bpo, but I feel like we should explain what happens in the documentation too.

@github-actions github-actions bot removed the stale Stale PR or inactive for long period of time. label Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

7 participants