Docstring fixes to comply with pydoclint - #171
Merged
Merged
Conversation
added 10 commits
November 18, 2025 10:31
… requests, and meta-feature requests
…nsistency with Google style - Updated parameter descriptions to use "Args" instead of "Parameters" for consistency. - Improved clarity of function descriptions and return types. - Standardized formatting of docstrings to follow a consistent style. - Enhanced readability by ensuring uniformity in the presentation of arguments and return values. - Adjusted example sections for clarity in usage.
…onsistency, adding missing exceptions and detailed argument descriptions.
…nhance input validation
…workflow and improve clarity
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…for clarity and consistency
anschaible
approved these changes
Dec 1, 2025
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
2 participants
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.
added pydoclint as pre-commit hook and changed docstrings to comply with this.