Skip to content

Standardize docstrings to Google style #65

@TravisBumgarner

Description

@TravisBumgarner

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

  • All public methods use Google-style docstrings
  • Remove redundant type info from docstrings (types are in annotations)
  • Consistent formatting across all modules
  • mkdocstrings renders all docstrings correctly

Files to Update

  • _Plotter.py
  • Plotter2D.py
  • Plotter3D.py
  • layer/_Layer.py
  • layer/Layer2D.py
  • layer/Layer3D.py
  • instruction/instructions.py (after consolidation)

Dependencies

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions