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.

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

1 participant