-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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.
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
Clarify docstring descriptions of cross-axis slope #1530
Conversation
The previous description for the signs of cross axis tilt mentioned slope azimuth as east for both positive and negative. Corrected it to indicate that sign of cross axis tilt is positive when axis azimuth is south and slope is towards west.
We're all for clarifying docstrings. The existing docstring says "negative cross-axis tilt if the tracker axes plane slopes down to the east and positive Would "positive cross-axis tilt if the tracker axes plane slopes down to the west" be more clear? |
Ohh I see! Apologies for missing that part. I think phrasing it as "positive cross-axis tilt if the tracker axes plane slopes down to the west" might make it more clear. As it will line up well with the other definitions throughout the documentation, where sloping down is generally used to to get the direction. For example (from the same file):
In both these cases the intuitive reference is sloping down, at least from how I understand it. |
I agree. |
@chiragpachori will you be able to update this PR? If not, one of us can do it, just let us know. |
Co-authored-by: Kevin Anderson <kevin.anderson@nrel.gov>
Co-authored-by: Kevin Anderson <kevin.anderson@nrel.gov>
Thanks @chiragpachori! |
@cwhanse Sorry I missed your comment. Thank you for sorting it out. @kanderso-nrel |
The previous description for the signs of cross axis tilt mentioned slope azimuth as east for both positive and negative. Corrected it to indicate that sign of cross axis tilt is positive when axis azimuth is south and slope is towards west.
This is a minor documentation error and I used the tracking.calc_cross_axis_tilt function to make sure that I an getting positive sign when slope is facing west.