Code Style Guide¶
The canonical coding standards for this repository live in the repository root STYLE_GUIDE.md.
What To Follow¶
Use the root style guide as the source of truth for:
- Comprehensive type hints on public APIs.
- Google-style docstrings for public modules, classes, and methods.
- Consistent imports, naming, and module structure.
- Focused tests with strong coverage expectations.
- Clear exception handling and API parameter validation.
Related Guides¶
- Documentation Style Guide - Writing guidance for docs pages.
- Development Overview - Local setup, quality checks, and docs build commands.
- Repository Root Style Guide - Canonical source document.