Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 29, 2023

Conversation

sobolevn
Copy link
Member

@sobolevn sobolevn commented Sep 28, 2023

Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

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
Member Author

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

@sobolevn
Copy link
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.

@sobolevn
Copy link
Member Author

Copy link
Member

@AA-Turner AA-Turner left a comment

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
Member

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

A

Copy link
Member

@hugovk hugovk left a comment

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
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