docs: add Google-style docstrings to errors.py#55
Conversation
|
@Aashita101 Thanks for you contribution , I'm on it will review it shortly |
Hell1213
left a comment
There was a problem hiding this comment.
Review: docs/errors-docstrings
Hi @Aashita101, thanks for the PR! The docstrings look clean and well-formatted.
One thing to note: PR #51 by @Rudrani-Mukherjee also addresses the same issue (#30) with docstrings for utils/errors.py. Both PRs modify the same file with different wording. You may want to coordinate with each other or the maintainers will pick one.
Minor: The file ends with a proper newline (good), unlike PR #51 which is missing one.
Tests pass, no lint issues introduced.
Hell1213
left a comment
There was a problem hiding this comment.
Docstrings look clean, follow the right Google-style format. Good addition.
|
Hi @Hell1213! Just wanted to note that the 2 failing checks are workflow/environment related — not caused by the docstring changes: |
Summary
Added Google-style docstrings to all public classes and methods in utils/errors.py
Related Issue
Fixes #30
Type of Change
Testing
uv run ruff checkpassesuv run mypypassesuv run pytestpassesDescription
Added Google-style docstrings to the
AgentErrorandConfigErrorclasses inutils/errors.py, including their__init__,__str__, andto_dictmethods. The docstrings follow the Google format with Args, Returns, and Attributes sections where applicable.