docs: parametrize add_numbers test example to match readability guidance - #798
Merged
Conversation
willingc
approved these changes
Sep 10, 2026
willingc
left a comment
willingc
left a comment
Collaborator
There was a problem hiding this comment.
Thanks @InessaPawson. Much clearer.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The "Write tests that are easy to review" section, added in #684, recommends descriptive test names and keeping one behavior in focus per test. The first add_numbers test example on the same page, in the "Test examples" admonition, did the opposite: a generically named test_add_numbers() bundling three cases with three separate assertions, followed by a module-level test_add_numbers() call. This PR updates that example to follow the guidelines introduced in #684.