X Tutup
Skip to content

gh-124234: Improve docs for Mock.reset_mock#124237

Merged
sobolevn merged 2 commits intopython:mainfrom
sobolevn:issue-124234
Sep 26, 2024
Merged

gh-124234: Improve docs for Mock.reset_mock#124237
sobolevn merged 2 commits intopython:mainfrom
sobolevn:issue-124234

Conversation

@sobolevn
Copy link
Member

@sobolevn sobolevn commented Sep 19, 2024 •
edited by github-actions bot
Loading

@cjw296 I don't think we ever set type annotations to the method signatures in docs. We only communicate this with the text itself.

So, I added two doctest examples that show how to use these parameters.

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

@sobolevn sobolevn added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Sep 19, 2024
@sobolevn sobolevn requested a review from cjw296 September 19, 2024 08:11
@bedevere-app bedevere-app bot added awaiting core review docs Documentation in the Doc dir skip news labels Sep 19, 2024
@bedevere-app bedevere-app bot mentioned this pull request Sep 19, 2024
Closed
@cjw296
Copy link
Contributor

cjw296 commented Sep 19, 2024

Oh, I meant adding a type annotation in the code in mock.py, I don't know why we don't do more of this in the stdlib?

cjw296
cjw296 approved these changes Sep 19, 2024
View reviewed changes
Copy link
Contributor

@cjw296 cjw296 left a comment

Choose a reason for hiding this comment

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

Looks good!

@sobolevn
Copy link
Member Author

sobolevn commented Sep 19, 2024

@cjw296 oh, sure! I can do this as well. Simple : bool annotation won't hurt, I guess :)

@sobolevn
Copy link
Member Author

sobolevn commented Sep 20, 2024

Done! 👍

@sobolevn sobolevn requested a review from cjw296 September 24, 2024 07:06
cjw296
cjw296 approved these changes Sep 26, 2024
View reviewed changes
Copy link
Contributor

@cjw296 cjw296 left a comment

Choose a reason for hiding this comment

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

You may know, but I do not: are the doctest examples, such as those you've added, actually executed by CPython CI?

@sobolevn
Copy link
Member Author

sobolevn commented Sep 26, 2024

are the doctest examples, such as those you've added, actually executed by CPython CI?

Yes, they are. We have a special Doctest job that does that.
See https://github.com/python/cpython/actions/runs/10954436653/job/30416486376?pr=124237#step:8:372

We have 465 tests in mock.rst docs :)

@sobolevn sobolevn merged commit 19fed6c into python:main Sep 26, 2024
@miss-islington-app
Copy link

miss-islington-app bot commented Sep 26, 2024

Thanks @sobolevn for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app
Copy link

miss-islington-app bot commented Sep 26, 2024

Sorry, @sobolevn, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 19fed6cf6eb51044fd0c02c6338259e2dd7fd462 3.13

@sobolevn
Copy link
Member Author

sobolevn commented Sep 26, 2024

Thank you for your reviews and help 🤝

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 26, 2024
@sobolevn @miss-islington
pythongh-124234: Improve docs for Mock.reset_mock (pythonGH-124237)
c575632 
(cherry picked from commit 19fed6c)

Co-authored-by: sobolevn <mail@sobolevn.me>
@bedevere-app
Copy link

bedevere-app bot commented Sep 26, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Sep 26, 2024
@sobolevn
Copy link
Member Author

sobolevn commented Sep 26, 2024

We need to first merge #124231 to backport this change to 3.13

sobolevn added a commit that referenced this pull request Sep 26, 2024
@miss-islington @sobolevn
[3.12] gh-124234: Improve docs for Mock.reset_mock (GH-124237) (#12…
51b62fb 
…4592)

gh-124234: Improve docs for `Mock.reset_mock` (GH-124237)
(cherry picked from commit 19fed6c)

Co-authored-by: sobolevn <mail@sobolevn.me>
@hugovk hugovk removed the needs backport to 3.13 bugs and security fixes label Feb 21, 2025
@hugovk hugovk added the needs backport to 3.13 bugs and security fixes label Feb 21, 2025
@miss-islington-app
Copy link

miss-islington-app bot commented Feb 21, 2025

Thanks @sobolevn for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 21, 2025
@sobolevn @miss-islington
pythongh-124234: Improve docs for Mock.reset_mock (pythonGH-124237)
e68b89a 
(cherry picked from commit 19fed6c)

Co-authored-by: sobolevn <mail@sobolevn.me>
@bedevere-app
Copy link

bedevere-app bot commented Feb 21, 2025

GH-130408 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Feb 21, 2025
hugovk pushed a commit that referenced this pull request Feb 21, 2025
@miss-islington @sobolevn
[3.13] gh-124234: Improve docs for Mock.reset_mock (GH-124237) (#13…
8db3eee 
…0408)

Co-authored-by: sobolevn <mail@sobolevn.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cjw296 cjw296 cjw296 approved these changes

Assignees

@sobolevn sobolevn

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sobolevn @cjw296 @hugovk
X Tutup