docs: Modernize and fix docstrings in connection.py #91
Conversation
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
Member
privateip
commented
Dec 12, 2025
privateip
commented
- Convert all docstrings to concise Google-style format with consistent structure
- Remove redundant type information from Args sections (types already in signatures)
- Fix incorrect parameter documentation in HTTP methods (get, post, put, delete, patch)
- Add missing Returns and Raises sections to all public methods
- Update type annotations in signatures to use modern syntax (T | None, dict, list)
- Document RequestError and HTTPStatusError exceptions consistently across all methods
- Apply fixes to both synchronous Connection and asynchronous AsyncConnection classes
- Reduce docstring verbosity while maintaining clarity and accuracy
- Convert all docstrings to concise Google-style format with consistent structure - Remove redundant type information from Args sections (types already in signatures) - Fix incorrect parameter documentation in HTTP methods (get, post, put, delete, patch) - Add missing Returns and Raises sections to all public methods - Update type annotations in signatures to use modern syntax (T | None, dict, list) - Document RequestError and HTTPStatusError exceptions consistently across all methods - Apply fixes to both synchronous Connection and asynchronous AsyncConnection classes - Reduce docstring verbosity while maintaining clarity and accuracy
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.