Repository navigation
docs: clarify range direction and default steps - #378
Merged
Merged
Conversation
Updated docstring for range_ and range_right functions to clarify behavior regarding step parameter and output
Add the contributor entry requested by CONTRIBUTING.rst.
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
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 range docs had the direction backwards:
range_(4, 1)counts down by default, andrange_right(4, 1)reverses that into an ascending sequence.This updates the descriptions and adds executable examples for negative bounds and an explicit step in the wrong direction. Runtime behavior stays the same.
Checked on Python 3.14: 2880 tests and doctests passed, Ruff passed for the changed module, and the Sphinx build passed with warnings treated as errors. Other Python versions were not run locally.