Skip to content

Documentation: Better documentation of yaw_optimizer_sr.py #1021

@paulf81

Description

@paulf81

Documentation: Better documentation of yaw_optimizer_sr.py

The file yaw_optimizer_sr.py could use better in-place documentation and complete docstrings.

Proposed solution

Recommend to go through file and:

  • Add docstrings
  • Remove commented blocks of code
  • Add type hints
  • Add comments where helpful

Additional context

Would be helpful for questions like #1013

Metadata

Metadata

Assignees

No one assigned

    Labels

    backlogTasks that need to be done but aren't scheduled. Higher priority than ideas-list.documentationin-progressWork is actively in progress

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions