Skip to content

gh-85453: Fix 'time zone' spelling issues across datetime.rst #118449

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 5 commits into from
Jul 16, 2024

Conversation

uatach
Copy link
Contributor

@uatach uatach commented Apr 30, 2024

Another pull request based on PR #21447, this one focused on fixing spelling issues on occurrences of 'time zone'.


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

@uatach uatach requested review from pganssle and abalkin as code owners April 30, 2024 20:01
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Apr 30, 2024
@uatach uatach changed the title Fix 'time zone' spelling issues across datetime.rst gh-85453: Fix 'time zone' spelling issues across datetime.rst Apr 30, 2024
@pganssle
Copy link
Member

pganssle commented May 1, 2024

I think timezone is also an acceptable spelling, if that's what we've been consistently using, we should probably continue using that.

Alternatively, we could differentiate between datetime.timezone (the class) and the more abstract notion of a "time zone" by including the space for the abstract notion, but I'm more inclined to mark out references to the class with backticks / class references rather than a spelling difference.

@uatach
Copy link
Contributor Author

uatach commented May 1, 2024

I think timezone is also an acceptable spelling, if that's what we've been consistently using, we should probably continue using that.

I'm not sure... the IANA database uses "time zone" and both Wikipedia and The Free Dictionary redirect "timezone" to "time zone"... so maybe "timezone" isn't even valid spelling but people use it anyway?

Alternatively, we could differentiate between datetime.timezone (the class) and the more abstract notion of a "time zone" by including the space for the abstract notion, but I'm more inclined to mark out references to the class with backticks / class references rather than a spelling difference.

Yes, I tried to differentiate all of them (the class and the instances and objects of the class) from the abstract concept.

@uatach
Copy link
Contributor Author

uatach commented May 24, 2024

Hello @erlend-aasland, any issues with this PR?

@erlend-aasland
Copy link
Contributor

@uatach, I'll have a look in the next couple of days.

@erlend-aasland
Copy link
Contributor

Alternatively, we could differentiate between datetime.timezone (the class) and the more abstract notion of a "time zone" by including the space for the abstract notion, but I'm more inclined to mark out references to the class with backticks / class references rather than a spelling difference.

I think it would be an improvement to consistently use spell it "time zone" in the prose; it would help separate the class from the abstract concept even more.

Both spelling variants are used across the Python docs; I think we would benefit from a consistent spelling all across the docs. Moreover, most dictionaries seem to use "time zone", and as long as that is true, we're bound to get "spelling correction PRs" from time to time.

@erlend-aasland erlend-aasland added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels May 27, 2024
@uatach uatach requested a review from erlend-aasland June 4, 2024 20:07
Copy link
Contributor

@erlend-aasland erlend-aasland left a comment

Choose a reason for hiding this comment

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

Thanks; I believe this is an improvement. I'll await a few days before landing to give Paul time to chime in, in case he really don't want this to go in.

@nedbat
Copy link
Member

nedbat commented Jul 15, 2024

I created a "time zone" entry in the style guide: python/devguide#1352

@nedbat
Copy link
Member

nedbat commented Jul 15, 2024

Should we also recommend "date and time", or is "datetime" better because it's compact and people will understand what we mean?

@erlend-aasland
Copy link
Contributor

Should we also recommend "date and time", or is "datetime" better because it's compact and people will understand what we mean?

With the "time zone" / "timezone" clarification in place, it would also make sense to clarify "datetime" / "date and time", IMO.

@erlend-aasland
Copy link
Contributor

Anyway, I read python/devguide#1352 as a blessing from the EB to go forth with this PR.

Sorry it took so long to land this, @uatach; thanks for your good work!

@erlend-aasland erlend-aasland merged commit 1755df7 into python:main Jul 16, 2024
27 checks passed
@miss-islington-app

This comment was marked as outdated.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 16, 2024
…etime.rst (pythonGH-118449)

(cherry picked from commit 1755df7)

Co-authored-by: edson duarte <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Jul 16, 2024

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 16, 2024
…etime.rst (pythonGH-118449)

(cherry picked from commit 1755df7)

Co-authored-by: edson duarte <[email protected]>
@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 16, 2024
@bedevere-app
Copy link

bedevere-app bot commented Jul 16, 2024

GH-121838 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 Jul 16, 2024
erlend-aasland pushed a commit that referenced this pull request Jul 16, 2024
…tetime.rst (GH-118449) (#121838)

(cherry picked from commit 1755df7)

Co-authored-by: edson duarte <[email protected]>
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
erlend-aasland pushed a commit that referenced this pull request Jul 23, 2024
…tetime.rst (GH-118449) (#121837)

(cherry picked from commit 1755df7)

Co-authored-by: edson duarte <[email protected]>
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.

4 participants