Skip to content

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

Merged
hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-109961-2
Sep 29, 2023
Merged

hugovk merged 3 commits into
python:mainfrom
sobolevn:issue-109961-2

Conversation

@sobolevn

@sobolevn sobolevn commented Sep 28, 2023 •

Copy link
Copy Markdown
Member

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Other anchors for object methods do not contain "builtins." prefix. For example https://docs.python.org/3/reference/datamodel.html#object.__format__.

Did you try to use .. currentmodule:: .? I am not sure whether :module: . works.

@sobolevn

Copy link
Copy Markdown
Member Author

@serhiy-storchaka hm, indeed. Will try that as well!

@sobolevn

Copy link
Copy Markdown
Member Author

The result is identical. Please, take a look.

The difference with datamodel.rst is that datamodel.rst does not have .. module:: directive at all. While copy has it on the very top.

Comment thread Doc/library/copy.rst Outdated
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@sobolevn

Copy link
Copy Markdown
Member Author

@AA-Turner AA-Turner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

A

@AA-Turner

Copy link
Copy Markdown
Member

@sobolevn -- when you do the backports, please could you include this commit in them? Saves merge conflicts etc.

A

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@hugovk
hugovk merged commit f1b1680 into python:main Sep 29, 2023
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
…10027)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
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 news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants