docs(experimental): add docstrings to default task handler functions#2661
Open
putramkti wants to merge 1 commit into
Open
Conversation
Six public async functions in task_handlers.py lacked docstrings, violating the project's requirement that public APIs have docstrings (AGENTS.md, CONTRIBUTING.md). Each docstring describes the function's purpose and the error code it returns by default.
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
Six public async functions in
src/mcp/client/experimental/task_handlers.pywere missing docstrings, while the surrounding module docstrings andCONTRIBUTING.md("Include docstrings for public APIs") establish the convention.Functions fixed:
default_get_task_handlerdefault_get_task_result_handlerdefault_list_tasks_handlerdefault_cancel_task_handlerdefault_task_augmented_samplingdefault_task_augmented_elicitationEach docstring describes the function's purpose and the error code it returns by default, consistent with the style used elsewhere in the same file.
Changes
src/mcp/client/experimental/task_handlers.py: +6 one-line docstrings, no logic changesChecklist
ruff checkpassesruff format --checkpassespyrightpasses (0 errors)pytest tests/client/passes (200 passed, 1 xfailed)