Skip to content
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

Fix more references to datetime and time classes #114717

Merged
merged 1 commit into from
Jan 29, 2024

Conversation

serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented Jan 29, 2024

They could be confused with references to datetime and time modules.


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

They could be confused with references to datetime and time modules.
@serhiy-storchaka
Copy link
Member Author

@smontanaro, please look at this.

@smontanaro
Copy link
Contributor

@serhiy-storchaka The changes to all three files LGTM.

@serhiy-storchaka serhiy-storchaka merged commit 39c766b into python:main Jan 29, 2024
30 checks passed
@miss-islington-app
Copy link

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@serhiy-storchaka serhiy-storchaka deleted the docs-datetime-refs branch January 29, 2024 16:20
@miss-islington-app
Copy link

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 39c766b579cabc71a4a50773d299d4350221a70b 3.12

@miss-islington-app
Copy link

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 39c766b579cabc71a4a50773d299d4350221a70b 3.11

serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Jan 29, 2024
)

They could be confused with references to datetime and time modules.
(cherry picked from commit 39c766b)

Co-authored-by: Serhiy Storchaka <[email protected]>
@@ -1678,7 +1678,7 @@ Usage of ``KabulTz`` from above::
:class:`.time` Objects
----------------------

A :class:`time` object represents a (local) time of day, independent of any particular
A :class:`.time` object represents a (local) time of day, independent of any particular
Copy link
Member

Choose a reason for hiding this comment

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

Nit: I don't think it's worth its own PR to make just this change, but FWIW, I would have just suppressed the link here, i.e.

Suggested change
A :class:`.time` object represents a (local) time of day, independent of any particular
A :class:`!time` object represents a (local) time of day, independent of any particular

The link is not useful, as it only takes the user two lines lower on the same page. It only adds visual clutter to the docs

@bedevere-app
Copy link

bedevere-app bot commented Jan 29, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Jan 29, 2024
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Jan 29, 2024
)

They could be confused with references to datetime and time modules.
(cherry picked from commit 39c766b)

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

bedevere-app bot commented Jan 29, 2024

GH-114726 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Jan 29, 2024
serhiy-storchaka added a commit that referenced this pull request Jan 29, 2024
…H-114726)

They could be confused with references to datetime and time modules.
(cherry picked from commit 39c766b)
serhiy-storchaka added a commit that referenced this pull request Jan 29, 2024
…H-114725)

They could be confused with references to datetime and time modules.
(cherry picked from commit 39c766b)

Co-authored-by: Serhiy Storchaka <[email protected]>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
They could be confused with references to datetime and time modules.
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants