Skip to content

bpo-38421: Update email.utils documentation #16678

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

Merged
merged 2 commits into from
Nov 12, 2019

Conversation

Irishsmurf
Copy link
Contributor

@Irishsmurf Irishsmurf commented Oct 9, 2019

Updates documentation around email.utils.parsedate_tz().

Currently, the documentation specifies that when a string without a is timezone passed to parsedate_tz(), the last tuple is returned as None.

This is no longer true since Python 3.3

https://bugs.python.org/issue38421

Automerge-Triggered-By: @encukou

Updates documentation around email.utils.parsedate_tz().

Currently, the documentation specifies that when a string without a is timezone passed to parsedate_tz(), the last tuple is returned as ```None```.
This is no longer true since Python 3.4
@Irishsmurf Irishsmurf requested a review from a team as a code owner October 9, 2019 13:36
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@Irishsmurf

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@brandtbucher
Copy link
Member

Thanks for your time @Irishsmurf, and welcome to CPython!

I assume that you've seen the bot's message about the CLA?

Copy link
Member

@brandtbucher brandtbucher left a comment

Choose a reason for hiding this comment

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

This looks like a good change to me!

Copy link
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Thanks @Irishsmurf for the contribution. This looks good to me.

@brandtbucher I will leave for the email team to review and merge. Thanks for triaging.

@brandtbucher
Copy link
Member

Thanks for the review @willingc. One question I have, going forward:

This PR changes four words of documentation and can be verified as correct by either running or reading the source code. It also doesn't touch on the intricacies of email itself.

Do we typically still require email team review for this, or in general anything relating to email even a little bit? It's okay if they're the gatekeepers here, but otherwise I'm not sure if waiting is necessary...

@encukou
Copy link
Member

encukou commented Nov 5, 2019

Indeed, I'd rather merge this to all supported Python 3 versions, to let the email team handle more serious issues.
I plan to do that in a few weeks if there's no activity here.

@miss-islington
Copy link
Contributor

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

1 similar comment
@miss-islington
Copy link
Contributor

Sorry, I can't merge this PR. Reason: Base branch was modified. Review and try the merge again..

@miss-islington miss-islington merged commit a12255d into python:master Nov 12, 2019
@miss-islington
Copy link
Contributor

Thanks @Irishsmurf for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

I'm having trouble backporting to 3.8. Reason: 'Error 110 while writing to socket. Connection timed out.'. Please retry by removing and re-adding the needs backport to 3.8 label.

@bedevere-bot
Copy link

GH-17121 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 12, 2019
Updates documentation around email.utils.parsedate_tz().

Currently, the documentation specifies that when a string without a is timezone passed to parsedate_tz(), the last tuple is returned as ```None```.

This is no longer true since Python 3.3

https://bugs.python.org/issue38421
(cherry picked from commit a12255d)

Co-authored-by: David K <[email protected]>
@miss-islington
Copy link
Contributor

Thanks @Irishsmurf for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-17122 is a backport of this pull request to the 3.8 branch.

miss-islington added a commit that referenced this pull request Nov 12, 2019
Updates documentation around email.utils.parsedate_tz().

Currently, the documentation specifies that when a string without a is timezone passed to parsedate_tz(), the last tuple is returned as ```None```.

This is no longer true since Python 3.3


https://bugs.python.org/issue38421
(cherry picked from commit a12255d)


Co-authored-by: David K <[email protected]>


https://bugs.python.org/issue38421



Automerge-Triggered-By: @encukou
miss-islington added a commit that referenced this pull request Nov 12, 2019
Updates documentation around email.utils.parsedate_tz().

Currently, the documentation specifies that when a string without a is timezone passed to parsedate_tz(), the last tuple is returned as ```None```.

This is no longer true since Python 3.3


https://bugs.python.org/issue38421
(cherry picked from commit a12255d)


Co-authored-by: David K <[email protected]>


https://bugs.python.org/issue38421



Automerge-Triggered-By: @encukou
@brandtbucher
Copy link
Member

Congrats on your first CPython contribution @Irishsmurf! 🍾

Looking forward to seeing more from you in the future.

jacobneiltaylor pushed a commit to jacobneiltaylor/cpython that referenced this pull request Dec 5, 2019
Updates documentation around email.utils.parsedate_tz().

Currently, the documentation specifies that when a string without a is timezone passed to parsedate_tz(), the last tuple is returned as ```None```.

This is no longer true since Python 3.3


https://bugs.python.org/issue38421
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
Updates documentation around email.utils.parsedate_tz().

Currently, the documentation specifies that when a string without a is timezone passed to parsedate_tz(), the last tuple is returned as ```None```.

This is no longer true since Python 3.3


https://bugs.python.org/issue38421
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants