gh-109961: Docs: Fix incorrect rendering of `replace` in `copy.rst` by sobolevn · Pull Request #109968 · python/cpython · GitHub

This is how it looks now:

I've also added __copy__ and __deepcopy__ definitions, so they can be referenced.

Refs #101100

Issue: Incorrect rendering of __replace__ method in copy docs: consider adding copy.SupportsReplace? #109961

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

…/copy.rst`

I think we could consider adding these to the datamodel and moving out of copy, I don't know what you'd think?

A

The markup changes for copy/deepcopy should be backported; replace should be left out.

A

I think we could consider adding these to the datamodel and moving out of copy, I don't know what you'd think?

Keeping these methods in the copy docs isn't without precedent: __fspath__ is documented in the os docs; __subclasshook__ is documented in the abc docs. I think there's an argument for keeping them close to the functions they're relevant to.

LGTM.

But please keep :noindex:. There are already entries for __replace__ etc, and duplicates that refer to the same target are confusing.

Hm, when adding noindex it starts to fail nitpick mode:

/Users/sobolev/Desktop/cpython/Doc/library/copy.rst:90: WARNING: py:meth reference target not found: object.__copy__
/Users/sobolev/Desktop/cpython/Doc/library/copy.rst:90: WARNING: py:meth reference target not found: object.__deepcopy__
/Users/sobolev/Desktop/cpython/Doc/library/copy.rst:112: WARNING: py:meth reference target not found: object.__replace__

With two indexes we have:

They link to:

copy.html#copy.object.__replace__
copy.html#index-2

Do we need the index directive itself now?

You could consider :noindexentry:?

A

It generated just one link in index.html: copy.html#index-2
No warnings 👍

Thanks, TIL about noindexentry :)

This answers a question I had: with noindexentry, can we still link to the method.
I just hope it’s not indexed as copy.object instead of builtins.object!

Of course, it is copy.object. https://cpython-previews--109968.org.readthedocs.build/en/109968/library/copy.html#copy.object.__replace__

You need to add .. currentmodule:: . to make it builtin.

Thanks @sobolevn for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

Sorry, @sobolevn and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 0baf72696e79191241a2d5cfdfd7e6135115f7b2 3.12

Sorry, @sobolevn and @hugovk, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 0baf72696e79191241a2d5cfdfd7e6135115f7b2 3.11

@sobolevn Please could you do the backports? Thank you!

I think this needs a follow-up PR for Serhiy's note: #109968 (comment)

A

Will do both :)

…opy.rst` (python#109968)

Will do both :)

@sobolevn Still needed? If not, let's remove the backport label.

…` in `copy.rst` (pythonGH-109968) (cherry picked from commit 0baf726) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

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

…copy.rst` (GH-109968) (#130909) (cherry picked from commit 0baf726) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

pythongh-109961 : Fix incorrect rendering of __replace__ in `library…

dd1bbb5

…/copy.rst`

bedevere-app Bot added the awaiting review label Sep 27, 2023

bedevere-app Bot mentioned this pull request Sep 27, 2023

Incorrect rendering of __replace__ method in copy docs: consider adding copy.SupportsReplace? #109961

Closed

sobolevn requested review from hugovk and serhiy-storchaka and removed request for serhiy-storchaka September 27, 2023 13:27

sobolevn added the skip news label Sep 27, 2023

AlexWaygood changed the title gh-109961: Fix incorrect rendering of __replace__ in library/copyrst gh-109961: Docs: Fix incorrect rendering of __replace__ in copy.rst Sep 27, 2023

AA-Turner added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Sep 27, 2023

AA-Turner added the docs Documentation in the Doc dir label Sep 27, 2023

serhiy-storchaka approved these changes Sep 27, 2023

View reviewed changes

bedevere-app Bot added awaiting core review and removed awaiting review labels Sep 27, 2023

serhiy-storchaka reviewed Sep 27, 2023

View reviewed changes

sobolevn added 2 commits September 27, 2023 17:48

keep noindex

15de5b9

Use :noindexentry:

e9ea514

merwok reviewed Sep 27, 2023

View reviewed changes

hugovk approved these changes Sep 28, 2023

View reviewed changes

hugovk merged commit 0baf726 into python:main Sep 28, 2023

bedevere-app Bot removed the awaiting core review label Sep 28, 2023

miss-islington assigned hugovk Sep 28, 2023

sobolevn mentioned this pull request Sep 28, 2023

gh-109961: Use proper module for copy method docs #110027

Merged

csm10495 pushed a commit to csm10495/cpython that referenced this pull request Sep 29, 2023

pythongh-109961 : Docs: Fix incorrect rendering of __replace__ in `c…

bb70d79

…opy.rst` (python#109968)

Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024

pythongh-109961 : Docs: Fix incorrect rendering of __replace__ in `c…

d354ddd

…opy.rst` (python#109968)

ZeroIntensity removed the needs backport to 3.11 only security fixes label Feb 17, 2025

hugovk pushed a commit to hugovk/cpython that referenced this pull request Mar 6, 2025

[3.12] pythongh-109961 : Docs: Fix incorrect rendering of `__replace__…

876274b

…` in `copy.rst` (pythonGH-109968) (cherry picked from commit 0baf726) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Mar 6, 2025

hugovk added a commit that referenced this pull request Mar 17, 2025

[3.12] gh-109961 : Docs: Fix incorrect rendering of __replace__ in `…

3983fca

…copy.rst` (GH-109968) (#130909) (cherry picked from commit 0baf726) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

               Function :func:`replace` is more limited than :func:`copy` and :func:`deepcopy`,
               and only supports named tuples created by :func:`~collections.namedtuple`,
-              :mod:`dataclasses`, and other classes which define method :meth:`!__replace__`.
+              :mod:`dataclasses`, and other classes which define method :meth:`~object.__replace__`.

-              The memo dictionary should be treated as an opaque object.
+              special methods :meth:`~object.__copy__` and :meth:`~object.__deepcopy__`.
+              .. method:: object.__copy__(self)

gh-109961: Docs: Fix incorrect rendering of `__replace__` in `copy.rst` by sobolevn · Pull Request #109968 · python/cpython · GitHub

Repository navigation

gh-109961: Docs: Fix incorrect rendering of __replace__ in copy.rst - #109968

gh-109961: Docs: Fix incorrect rendering of __replace__ in copy.rst#109968hugovk merged 3 commits intopython:mainpython/cpython:mainfrom sobolevn:issue-109961sobolevn/cpython:issue-109961Copy head branch name to clipboard

Conversation

sobolevn commented Sep 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AA-Turner commented Sep 27, 2023

Uh oh!

AA-Turner commented Sep 27, 2023

Uh oh!

AlexWaygood commented Sep 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka Sep 27, 2023

Choose a reason for hiding this comment

Uh oh!

sobolevn Sep 27, 2023

Choose a reason for hiding this comment

Uh oh!

sobolevn Sep 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AA-Turner Sep 27, 2023

Choose a reason for hiding this comment

Uh oh!

sobolevn Sep 27, 2023

Choose a reason for hiding this comment

Uh oh!

merwok Sep 27, 2023

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka Sep 28, 2023

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Sep 28, 2023

Uh oh!

miss-islington commented Sep 28, 2023

Uh oh!

miss-islington commented Sep 28, 2023

Uh oh!

hugovk commented Sep 28, 2023

Uh oh!

AA-Turner commented Sep 28, 2023

Uh oh!

sobolevn commented Sep 28, 2023

Uh oh!

hugovk commented Feb 20, 2025

Uh oh!

bedevere-app Bot commented Mar 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

gh-109961: Docs: Fix incorrect rendering of `replace` in `copy.rst` by sobolevn · Pull Request #109968 · python/cpython · GitHub

gh-109961: Docs: Fix incorrect rendering of replace in copy.rst - #109968

gh-109961: Docs: Fix incorrect rendering of replace in copy.rst#109968
hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-109961

sobolevn commented Sep 27, 2023 •
edited
Loading

AlexWaygood commented Sep 27, 2023 •
edited
Loading

sobolevn Sep 27, 2023 •
edited
Loading