Fix incorrect docstring for get_all_awaited_by in _remote_debugging (GH-149302)#149312
Open
Shankarraospatil wants to merge 2 commits intopython:mainfrom
Open
Fix incorrect docstring for get_all_awaited_by in _remote_debugging (GH-149302)#149312Shankarraospatil wants to merge 2 commits intopython:mainfrom
Shankarraospatil wants to merge 2 commits intopython:mainfrom
Conversation
|
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 |
|
All commit authors signed the Contributor License Agreement. |
Shankarraospatil
changed the title
Author
|
Please add the "skip news" label, as this change only updates a docstring. |
|
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.
The docstring for RemoteUnwinder.get_all_awaited_by incorrectly described
the return type as a list of [frames, task_name, subtasks].
This PR updates the docstring to reflect the actual return structure
(AwaitedInfo and TaskInfo) and replaces the outdated example.
_remote_debugging: incorrect docstringget_all_awaited_by()#149302