Skip to content

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

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

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

Conversation

@Aashita101

Copy link
Copy Markdown
Owner

Summary

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

Related Issue

Fixes Hell1213#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.

@Aashita101 Aashita101 self-assigned this May 31, 2026
@Aashita101 Aashita101 added the documentation Improvements or additions to documentation label May 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docstrings to public functions in utility modules

1 participant