Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation: Better documentation of yaw_optimizer_sr.py #1021

Open
paulf81 opened this issue Nov 8, 2024 · 0 comments
Open

Documentation: Better documentation of yaw_optimizer_sr.py #1021

paulf81 opened this issue Nov 8, 2024 · 0 comments
Labels
documentation

Comments

@paulf81
Copy link
Collaborator

paulf81 commented Nov 8, 2024

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@paulf81