]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
gh-115684: Clarify datetime `replace` documentation (#116519)
authorDavid Lowry-Duda <david@lowryduda.com>
Mon, 24 Mar 2025 15:33:16 +0000 (11:33 -0400)
committerGitHub <noreply@github.com>
Mon, 24 Mar 2025 15:33:16 +0000 (11:33 -0400)
commitd2d886215cf694d5f3e7f0cbd76507a96bac322b
tree3a7773e7dee1548b6997e7ca9e1e9d0b231aabb0
parentd716ea34cb8a105e8e39a1ddfd610c3c0f11a0e7
gh-115684: Clarify datetime `replace` documentation (#116519)

* Clarify datetime `replace` documentation

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 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 #115684.

* Include reviewer comments

Thanks Privat33r-dev for the comments!

---------

Co-authored-by: Paul Ganssle <1377457+pganssle@users.noreply.github.com>
Doc/library/datetime.rst