Description
The codebase uses a mix of docstring styles. Standardize to Google style for consistency and better mkdocstrings parsing.
Current Issues
- Some docstrings use
- param (type): format
- Others use different formats
- Inconsistent spacing and formatting
- Some methods missing Returns sections
Google Style Format
def add_point(self, x: float, y: float) -> Self:
"""Add a point to the layer.
Args:
x: The x-coordinate of the point.
y: The y-coordinate of the point.
Returns:
The Layer object for method chaining.
"""
Acceptance Criteria
Files to Update
_Plotter.py
Plotter2D.py
Plotter3D.py
layer/_Layer.py
layer/Layer2D.py
layer/Layer3D.py
instruction/instructions.py (after consolidation)
Dependencies
Description
The codebase uses a mix of docstring styles. Standardize to Google style for consistency and better mkdocstrings parsing.
Current Issues
- param (type):formatGoogle Style Format
Acceptance Criteria
Files to Update
_Plotter.pyPlotter2D.pyPlotter3D.pylayer/_Layer.pylayer/Layer2D.pylayer/Layer3D.pyinstruction/instructions.py(after consolidation)Dependencies