Fix gen_colors docstring: function yields, not returns a list#145288
Open
Anandesh-Sharma wants to merge 1 commit intopython:mainfrom
Open
Fix gen_colors docstring: function yields, not returns a list#145288Anandesh-Sharma wants to merge 1 commit intopython:mainfrom
Anandesh-Sharma wants to merge 1 commit intopython:mainfrom
Conversation
The gen_colors function is a generator (uses yield) with return type Iterator[ColorSpan], but its docstring incorrectly stated "Returns a list of index spans". Updated to "Yield index spans" to accurately reflect the function's behavior. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Anandesh-Sharma
requested review from
ambv,
lysnikolaou and
pablogsal
as code owners
|
The following commit authors need to sign the Contributor License Agreement: |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
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
1 participant
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
Lib/_pyrepl/utils.py::gen_colors()yield) with return typeIterator[ColorSpan], but the docstring stated "Returns a list of index spans"Test plan
python -m pytest Lib/test/test_pyrepl/passes