Replace "ordered arguments" with "positional arguments" in unittest.mock documentation #137552
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mock documentation
ZeroIntensity
approved these changes
Aug 8, 2025
|
Thanks @orf for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 8, 2025
…mock` documentation (pythonGH-137552) (cherry picked from commit 64ee1ba) Co-authored-by: Tom Forbes <tom@tomforb.es>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Aug 8, 2025
…mock` documentation (pythonGH-137552) (cherry picked from commit 64ee1ba) Co-authored-by: Tom Forbes <tom@tomforb.es>
|
GH-137553 is a backport of this pull request to the 3.14 branch. |
|
GH-137554 is a backport of this pull request to the 3.13 branch. |
|
Thanks @orf. It might be a little while until the 3.14 backport is merged, since the branch is currently locked. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a trivial change, replacing "ordered arguments" with "non-keyword arguments" inside the
unittest.mockdocumentation.Rationale
The confusing and unique terminology was pointed out to me whilst helping a new developer get started with mocks. They are quite familiar with python functions and arguments, but they where very confused by the phrase "ordered arguments". As far as I can tell, this is the only place that refers to non-keyword arguments as "ordered arguments" - arguments are ordered by virtue of them being arguments.
I'm happy to fiddle with the wording some more, but I figured simply changing it to "non-keyword" arguments makes things a bit clearer for newer developers?
📚 Documentation preview 📚: https://cpython-previews--137552.org.readthedocs.build/