docs: add Google-style docstrings to errors.py classes#51
Open
Rudrani-Mukherjee wants to merge 2 commits into
Open
docs: add Google-style docstrings to errors.py classes#51Rudrani-Mukherjee wants to merge 2 commits into
Rudrani-Mukherjee wants to merge 2 commits into
Conversation
10 tasks
Hell1213
reviewed
Jun 1, 2026
Owner
Hell1213
left a comment
Hell1213
left a comment
There was a problem hiding this comment.
Review: Google-style docstrings for errors.py
Hi @Rudrani-Mukherjee, thanks for the PR! The docstrings are well-written.
Minor: The file is missing a trailing newline at the end (line 87 ends without \n). Not a blocker with current ruff config (only E9,F enabled), but consider adding it.
Note: PR #55 by @Aashita101 also addresses the same issue (#30) with a slightly different docstring style. Both PRs modify utils/errors.py and will conflict. You may want to coordinate – or the maintainers will pick one.
Tests pass, no lint issues.
Hell1213
reviewed
Jun 1, 2026
Owner
Hell1213
left a comment
Hell1213
left a comment
There was a problem hiding this comment.
Docstrings look clean and follow Google format. Nice work.
Author
|
@Hell1213 Thank you for the review! Added the trailing newline at end of errors.py. Ready for merge |
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.
Summary
Added Google-style docstrings to all public classes and methods in
utils/errors.py.Changes
AgentErrorwith Attributes section__init__,__str__,to_dictmethodsConfigErrorwith Attributes sectionConfigError.__init__methodRelated Issue
Closes #30
Type of Change
Testing
uv run ruff checkpassesuv run mypypassesuv run pytestpassesDescription
Added Google-style docstrings to AgentError and ConfigError classes in utils/errors.py which were missing documentation.