Skip to content

bpo-9004: Recommend against using utctimetuple in the docs. - #10870

Closed
abalkin wants to merge 1 commit into
python:masterfrom
abalkin:issue-9004
Closed

bpo-9004: Recommend against using utctimetuple in the docs.#10870
abalkin wants to merge 1 commit into
python:masterfrom
abalkin:issue-9004

Conversation

@abalkin

@abalkinabalkin commented Dec 3, 2018•
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

Closes bpo-9004.

Original patch by Gaurav Tatke.

https://bugs.python.org/issue9004

@abalkin
Recommend against using utctimetuple in the docs.
270f17b
Closes issue 9004.
Original patch by Gaurav Tatke.
@bedevere-botbedevere-bot added docs Documentation in the Doc dir awaiting merge labels Dec 3, 2018
@nanjekyejoannah

nanjekyejoannah commented Mar 11, 2019•
edited
Loading

Copy link
Copy Markdown
Contributor

@abalkin please add a news entry.

You can use https://blurb-it.herokuapp.com/ to do this.

nanjekyejoannah
nanjekyejoannah reviewed Mar 11, 2019
View reviewed changes
Comment threadDoc/library/datetime.rst
If *tz* is not ``None``, it must be an instance of a :class:`tzinfo` subclass, and the
current date and time are converted to *tz*’s time zone. In this case the
result is equivalent to ``tz.fromutc(datetime.utcnow().replace(tzinfo=tz))``.
It is recommended to create aware datetime object for current UTC time by

@nanjekyejoannahnanjekyejoannahMar 11, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Am not a native english speaker but shouldn't this "It is recommended to create aware datetime object " be "It is recommended to create an aware datetime object for current" or "be "It is recommended to create aware datetime objects for current"

@JulienPalardJulienPalardSep 11, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Am not a native english speaker neither but I'd propose:

The recommended way to create aware datetime object for the current time in UTC is ...

@csabella

csabella commented Jun 5, 2019

Copy link
Copy Markdown
Contributor

cc @pganssle

@pganssle
pganssle self-requested a review June 16, 2019 14:37
@JulienPalard

JulienPalard commented Sep 11, 2019

Copy link
Copy Markdown
Member

@abalkin there's now a conflict on your PR, would you please rebase it on top of master?

@pganssle does this looks good to you? Have you a preferred wording?

@pganssle

pganssle commented Sep 11, 2019

Copy link
Copy Markdown
Member

I think maybe we should consolidate this into #15773.

@nanjekyejoannah Do you mind adding a similar warning box to .utctimetuple()? I don't think I even realized that this function exists 😞

@pgansslepganssle mentioned this pull request Sep 11, 2019
Merged
@pganssle

pganssle commented Sep 11, 2019

Copy link
Copy Markdown
Member

Closed in favor of #15773

@abalkinabalkin mentioned this pull request Apr 10, 2022
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JulienPalardJulienPalardJulienPalard left review comments
@nanjekyejoannahnanjekyejoannahnanjekyejoannah left review comments
@pgansslepganssleAwaiting requested review from pganssle

Assignees

No one assigned

Labels

awaiting mergedocsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@abalkin@nanjekyejoannah@csabella@JulienPalard@pganssle@the-knights-who-say-ni@bedevere-bot