gh-115684: Clarify datetime replace documentation
#116519
Merged
+12
−12
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
In python#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 python#115684.
bedevere-app
bot
added
awaiting review
docs
|
Thank you for your contribution, generally looks good and fixes the issue. |
Thanks Privat33r-dev for the comments!
|
Thanks! You're very quick on the reply, too. |
|
@pganssle do you want to review? :) If not, maybe we can ping other Core members responsible for documentation? |
|
I do not see any clarifications, just rewording. What do you think @pganssle ? |
pganssle
approved these changes
Mar 8, 2025
pganssle
added
3.12
|
Thanks @davidlowryduda for the PR, and @pganssle for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Mar 24, 2025
…16519) * 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]>
|
GH-131676 is a backport of this pull request to the 3.13 branch. |
|
Sorry, @davidlowryduda and @pganssle, I could not cleanly backport this to |
|
GH-131683 is a backport of this pull request to the 3.12 branch. |
davidlowryduda
added a commit
to davidlowryduda/cpython
that referenced
this pull request
Mar 24, 2025
…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]>
|
GH-131694 is a backport of this pull request to the 3.12 branch. |
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this pull request
Apr 1, 2025
) * Clarify datetime `replace` documentation In python#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 python#115684. * Include reviewer comments Thanks Privat33r-dev for the comments! --------- Co-authored-by: Paul Ganssle <[email protected]>
Yhg1s
pushed a commit
that referenced
this pull request
Apr 8, 2025
#131694) * Clarify datetime `replace` documentation In 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 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 GH-115684. * Include reviewer comments Thanks Privat33r-dev for the comments! --------- (cherry picked from commit d2d8862) Co-authored-by: Paul Ganssle <[email protected]>
Yhg1s
pushed a commit
that referenced
this pull request
Apr 8, 2025
#131676) gh-115684: Clarify datetime `replace` documentation (GH-116519) * Clarify datetime `replace` documentation In 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 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 GH-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]>
seehwan
pushed a commit
to seehwan/cpython
that referenced
this pull request
Apr 16, 2025
) * Clarify datetime `replace` documentation In python#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 python#115684. * Include reviewer comments Thanks Privat33r-dev for the comments! --------- Co-authored-by: Paul Ganssle <[email protected]>
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.
In #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 #115684.
📚 Documentation preview 📚: https://cpython-previews--116519.org.readthedocs.build/