Skip to content

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

Open
Rudrani-Mukherjee wants to merge 1 commit into
Hell1213:mainfrom
Rudrani-Mukherjee:docs/add-docstrings-errors
Open

docs: add Google-style docstrings to errors.py classes#51
Rudrani-Mukherjee wants to merge 1 commit into
Hell1213:mainfrom
Rudrani-Mukherjee:docs/add-docstrings-errors

Conversation

@Rudrani-Mukherjee
Copy link
Copy Markdown

Summary

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

Changes

  • Added class docstring to AgentError with Attributes section
  • Added docstrings to __init__, __str__, to_dict methods
  • Added class docstring to ConfigError with Attributes section
  • Added docstring to ConfigError.__init__ method

Related Issue

Closes #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 AgentError and ConfigError classes in utils/errors.py which were missing documentation.

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