[3.12] gh-115684: Clarify datetime replace documentation (GH-116519)
#131683
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…honGH-116519) * Clarify datetime `replace` documentation In pythonGH-115684, HopedForLuck noted that `datetime.date.replace()` documentation was confusing because it looked like it would be changing immutable objects. This documentation change specifies that the `replace()` methods in `datetime` return new objects. This uses similar wording to the documentation for `datetime.combine()`, which specifies that a new datetime is returned. This is also similar to wording for `string.replace()`, except `string.replace()` emphasizes that a "copy" is returned. Resolves pythonGH-115684. * Include reviewer comments Thanks Privat33r-dev for the comments! --------- (cherry picked from commit d2d8862) Co-authored-by: David Lowry-Duda <[email protected]> Co-authored-by: Paul Ganssle <[email protected]>
|
This incorrectly uses |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
replacedocumentationIn GH-115684, HopedForLuck noted that
datetime.date.replace()documentation was confusing because it looked like it would be changing immutable objects.This documentation change specifies that the
replace()methods indatetimereturn new objects. This uses similar wording to the documentation fordatetime.combine(), which specifies that a new datetime is returned. This is also similar to wording forstring.replace(), exceptstring.replace()emphasizes that a "copy" is returned.Resolves GH-115684.
Thanks Privat33r-dev for the comments!
(cherry picked from commit d2d8862)
📚 Documentation preview 📚: https://cpython-previews--131683.org.readthedocs.build/