-
Notifications
You must be signed in to change notification settings - Fork 1.1k
[BUGFIX] Inconsistent naming of cross_axis_tilt
/ cross_axis_slope
#2543
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
base: main
Are you sure you want to change the base?
[BUGFIX] Inconsistent naming of cross_axis_tilt
/ cross_axis_slope
#2543
Conversation
Currently targets v0.13.1, but I leave this decision up to anybody else (please, assign milestone accordingly). I will update deprecations tracker when merged. |
since="0.13.1", | ||
old_param_name="cross_axis_slope", | ||
new_param_name="cross_axis_tilt", | ||
removal="0.15.0", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removal="0.15.0", |
We usually don't specify a removal version as there's not standard timeline for when minor versions come out. If we really wanted to specify a removal, I think this should be in the form of a date, e.g., removal="Earliest September 2026"
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I never thought of that, but looks a promising idea
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm interested in what @wholmgren thinks of this?
The original thread #2334 contained multiple views in favor of |
@@ -44,6 +44,20 @@ There is a convention on consistent variable names throughout the library: | |||
bhi | |||
Beam/direct horizontal irradiance | |||
|
|||
cross_axis_tilt | |||
Cross-axis tilt angle [°]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we should go for this syntax given the current style guide and the rest of the nomenclature page
Cross-axis tilt angle [°]. | |
Cross-axis tilt angle. [°] |
Cross-axis tilt is measured by using a right-handed convention. | ||
For example, trackers with axis azimuth of 180 degrees (heading south) | ||
will have a negative cross-axis tilt if the tracker axes plane slopes | ||
down to the east and positive cross-axis tilt if the tracker axes plane | ||
slopes up to the east. | ||
Use :func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate | ||
``cross_axis_tilt`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few style suggestions, mostly my personal preference. Feel free to take them all, cherry pick a few, or reject them all.
Removed "by", swapped "degrees" for °, added a comma after east.
Cross-axis tilt is measured by using a right-handed convention. | |
For example, trackers with axis azimuth of 180 degrees (heading south) | |
will have a negative cross-axis tilt if the tracker axes plane slopes | |
down to the east and positive cross-axis tilt if the tracker axes plane | |
slopes up to the east. | |
Use :func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate | |
``cross_axis_tilt`` | |
Cross-axis tilt is measured using a right-handed convention. | |
For example, trackers with axis azimuth of 180° (heading south) | |
will have a negative cross-axis tilt if the tracker axes plane slopes | |
down to the east, and positive cross-axis tilt if the tracker axes plane | |
slopes up to the east. | |
Use :func:`~pvlib.tracking.calc_cross_axis_tilt` to calculate | |
``cross_axis_tilt`` |
Thanks for the reviews. @AdamRJensen , yeah, my fault. This is a stale branch I had locally - I guess I took that decision to conform with what already was the term prior to the newer feature and just skimmed through the discussion. I will change this whenever I can to reflect what was discussed. |
docs/sphinx/source/reference
for API changes.docs/sphinx/source/whatsnew
for all changes. Includes link to the GitHub Issue with:issue:`num`
or this Pull Request with:pull:`num`
. Includes contributor name and/or GitHub username (link with:ghuser:`user`
).remote-data
) and Milestone are assigned to the Pull Request and linked Issue.Extract from the body message, OP @williamhobbs, #2334 .
Also adds variable description to nomenclature page.
Relevant doc pages