docs: add missing docstrings to core client/server session API methods#2733
Open
sohammmmm10 wants to merge 1 commit into
Open
docs: add missing docstrings to core client/server session API methods#2733sohammmmm10 wants to merge 1 commit into
sohammmmm10 wants to merge 1 commit into
Conversation
Add docstrings to undocumented public methods in the client and server session modules: - ClientSession.initialize(): document handshake flow, return type, and RuntimeError on unsupported protocol version - ServerSession.client_params: document property returning client's InitializeRequestParams - ServerSession.incoming_messages: document the ServerRequestResponder stream property - remove_request_params(): document URL query-stripping utility These are the most user-facing public methods that currently lack docstrings, making IDE tooltips and help() output incomplete.
Author
|
Note: The single failing check ( Happy to rebase if needed once this is reviewed. |
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.
Add docstrings to undocumented public methods in the client and server session modules:
These are the most user-facing public methods that currently lack docstrings, making IDE tooltips and help() output incomplete.
Motivation and Context
How Has This Been Tested?
Breaking Changes
Types of changes
Checklist
Additional context