Fix: Clarify random_number function docstring for inclusive range #1475
+1
−1
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
… lifecycle_example.py) ## Summary Fixed an ambiguous docstring in the `random_number` function that could lead to confusion about whether the range is inclusive or exclusive of the maximum value. ## Problem The random_number function docstring was ambiguous, using "up to the provided maximum" which could be interpreted as either inclusive or exclusive of the maximum value. The implementation correctly uses `random.randint(0, max)` which generates numbers from 0 to max inclusive, matching the expected behavior based on usage in the example. ## Changes Made Changed the docstring from: ```python "Generate a random number up to the provided maximum." ``` To: ```python "Generate a random number from 0 to max (inclusive)." ``` This makes the behavior explicit and eliminates potential confusion for developers using this function.
|
A vital improvement. Ambiguity in docstrings, especially in helper functions like this, can have far-reaching consequences. It's good to see this kind of issue being addressed with the seriousness it deserves. |
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.
Summary
Fixed an ambiguous docstring in the
random_numberfunction (inlifecycle_example.py) that could lead to confusion about whether the range is inclusive or exclusive of the maximum value.Problem
The random_number function docstring was ambiguous, using "up to the provided maximum" which could be interpreted as either inclusive or exclusive of the maximum value.
The implementation correctly uses
random.randint(0, max)which generates numbers from 0 to max inclusive, matching the expected behavior based on usage in the example.Changes Made
Changed the docstring from:
"Generate a random number up to the provided maximum."To:
"Generate a random number from 0 to max (inclusive)."This makes the behavior explicit and eliminates potential confusion for developers using this function.