Commit c34f4a3
authored
Fix CI: Add maturin to dev dependencies (#27)
* docs: add comprehensive Google-style docstrings to all public APIs (#24)
Added comprehensive API documentation following Google-style docstring format:
- python/dioxide/__init__.py: Enhanced module docstring with quick start example
- python/dioxide/scope.py: Detailed Scope enum docs with usage examples
- python/dioxide/decorators.py: Complete @component decorator documentation
- python/dioxide/container.py: Comprehensive Container class documentation
All public methods now include:
- Clear description of purpose and behavior
- Args with types and detailed explanations
- Returns with type information
- Raises documenting exceptions
- Working, tested examples
- Usage notes and best practices
Documentation features:
- All examples are executable and tested
- Type hints match docstring descriptions
- IDE autocomplete shows full documentation
- help() function displays useful information
- Examples demonstrate common use cases
This completes issue #24 - Complete API Documentation
* fix(ci): add maturin to dev dependencies
Maturin was missing from dev dependencies, causing CI to fail when
running 'uv run maturin develop'. Maturin is specified in build-system
requirements but needs to be in dev dependencies for uv to find it.
* style: apply ruff formatting to decorators.py1 parent 463253c commit c34f4a3
File tree
5 files changed
+555
-88
lines changed- python/dioxide
5 files changed
+555
-88
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| 33 | + | |
33 | 34 | | |
34 | 35 | | |
35 | 36 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
2 | 28 | | |
3 | 29 | | |
4 | 30 | | |
| |||
0 commit comments