GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Added reference for return_value in unittest.mock documentation by Tialo · Pull Request #119207 · python/cpython

Conversation

@Tialo

@Tialo Tialo commented May 20, 2024 •
edited by github-actions Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

Added reference for return_value in documentation

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@Tialo
Added reference for return_value in unittest.mock documentation
960902a
@ghost

ghost commented May 20, 2024 •
edited by ghost
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels May 20, 2024
blaisep
blaisep approved these changes May 20, 2024
View reviewed changes

@blaisep blaisep left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Small change to improve consistency, Nice.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/unittest.mock.rst Outdated
(if any) are reset as well.

.. note:: *return_value*, and :attr:`side_effect` are keyword-only
.. note:: :attr:`return_value`, and :attr:`side_effect` are keyword-only

@blaisep blaisep May 20, 2024

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Nice! Attention to detail, increases consistency.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
blaisep reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

@blaisep blaisep May 20, 2024

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

@encukou , LMK if I need to look for anything else.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@encukou encukou May 20, 2024

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Both of these refer to the function arguments, so they should be marked up as such (*return_value* and *side_effect*).

But, a bit above in:

 In case you want to reset *return_value* or :attr:`side_effect`

these refer to attributes of the Mock objects, and should use :attr: (return_value should be changed to use :attr:).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-app bedevere-app Bot added awaiting core review and removed awaiting review labels May 20, 2024
@Tialo
attribute reference added
c106a4b
@Tialo

Tialo commented May 20, 2024

Copy link
Copy Markdown
Contributor Author

Also added :attr: for return_value above
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@encukou encukou added the skip issue label May 20, 2024
@encukou
encukou merged commit 6b80a5b into python:main May 20, 2024
@bedevere-app bedevere-app Bot removed the awaiting core review label May 20, 2024
@encukou

encukou commented May 20, 2024

Copy link
Copy Markdown
Member

Thank you!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@encukou encukou added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels May 20, 2024
@miss-islington-app

miss-islington-app Bot commented May 20, 2024

Copy link
Copy Markdown

Thanks @Tialo for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@miss-islington-app

miss-islington-app Bot commented May 20, 2024

Copy link
Copy Markdown

Thanks @Tialo for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 20, 2024
@Tialo @miss-islington
Use correct markup in unittest.mock.reset_mock documentation (pythonG…
c42b810 
…H-119207)

(cherry picked from commit 6b80a5b)

Co-authored-by: Tialo <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 20, 2024
@Tialo @miss-islington
Use correct markup in unittest.mock.reset_mock documentation (pythonG…
968201b 
…H-119207)

(cherry picked from commit 6b80a5b)

Co-authored-by: Tialo <[email protected]>
@bedevere-app

bedevere-app Bot commented May 20, 2024

Copy link
Copy Markdown

GH-119249 is a backport of this pull request to the 3.12 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.12 only security fixes label May 20, 2024
@bedevere-app

bedevere-app Bot commented May 20, 2024

Copy link
Copy Markdown

GH-119250 is a backport of this pull request to the 3.13 branch.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only security fixes label May 20, 2024
encukou pushed a commit that referenced this pull request May 20, 2024
@miss-islington @Tialo
[3.12] Use correct markup in unittest.mock.reset_mock documentation (G…
1738944 
…H-119207) (GH-119249)

Use correct markup in unittest.mock.reset_mock documentation (GH-119207)
(cherry picked from commit 6b80a5b)

Co-authored-by: Tialo <[email protected]>
encukou pushed a commit that referenced this pull request May 20, 2024
@miss-islington @Tialo
[3.13] Use correct markup in unittest.mock.reset_mock documentation (G…
906f6cb 
…H-119207) (GH-119250)

Use correct markup in unittest.mock.reset_mock documentation (GH-119207)
(cherry picked from commit 6b80a5b)

Co-authored-by: Tialo <[email protected]>
@Tialo
Tialo deleted the patch-1 branch May 23, 2024 18:24
@JelleZijlstra JelleZijlstra mentioned this pull request May 28, 2024
backport a9a74da 3.13 #119642
Closed
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@Tialo @estyxx
Use correct markup in unittest.mock.reset_mock documentation (pythonG…
a56a546 
…H-119207)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@encukou encukou encukou left review comments
+1 more reviewer
@blaisep blaisep blaisep approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@Tialo @encukou @blaisep
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.