Skip to content

docs: add Google-style docstrings to errors.py#55

Open
Aashita101 wants to merge 1 commit into
Hell1213:mainfrom
Aashita101:docs/errors-docstrings
Open

docs: add Google-style docstrings to errors.py#55
Aashita101 wants to merge 1 commit into
Hell1213:mainfrom
Aashita101:docs/errors-docstrings

Conversation

@Aashita101
Copy link
Copy Markdown

Summary

Added Google-style docstrings to all public classes and methods in utils/errors.py

Related Issue

Fixes #30

Type of Change

  • Bug fix
  • New feature
  • Documentation
  • Refactoring
  • Test changes
  • CI/Chore

Testing

  • uv run ruff check passes
  • uv run mypy passes
  • uv run pytest passes
  • Manual testing done

Description

Added Google-style docstrings to the AgentError and ConfigError classes in utils/errors.py, including their __init__, __str__, and to_dict methods. The docstrings follow the Google format with Args, Returns, and Attributes sections where applicable.

@Hell1213
Copy link
Copy Markdown
Owner

Hell1213 commented Jun 1, 2026

@Aashita101 Thanks for you contribution , I'm on it will review it shortly

Copy link
Copy Markdown
Owner

@Hell1213 Hell1213 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Owner

@Hell1213 Hell1213 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docstrings look clean, follow the right Google-style format. Good addition.

@Aashita101
Copy link
Copy Markdown
Author

Hi @Hell1213! Just wanted to note that the 2 failing checks are workflow/environment related — not caused by the docstring changes:
Gitleaks is failing due to GITHUB_TOKEN not being configured for PR scans
CI is failing due to a missing Gemini API key in the environment
The docstrings themselves pass formatting and review.
Since I'm the assigned contributor by the bot for issue #30, I'd appreciate it if this PR (#55) could be merged once the workflow configuration is sorted. Happy to help if needed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docstrings to public functions in utility modules

2 participants