8000 Add reference to `tracking.singleaxis` by RDaxini · Pull Request #2198 · pvlib/pvlib-python · GitHub
[go: up one dir, main page]
Skip to content

Add reference to tracking.singleaxis #2198

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
Merged
merged 5 commits into from
Sep 9, 2024
Merged

Add reference to tracking.singleaxis #2198

merged 5 commits into from
Sep 9, 2024

Conversation

RDaxini
Copy link
Contributor
@RDaxini RDaxini commented Sep 5, 2024 •
edited
Loading

I noticed Discussion #2137 and PR #2146 on wid/omega_ideal
I don't think the variable omega_ideal is mentioned in the cited publication (Anderson and Mikofski, 2020) either so I think it might help to add the original reference of this function for additional context, not just for this variable but also more generally too.

Changes summary:
Added reference
Other minor docstring edits e.g. adding `` around function arguments

@RDaxini
Update tracking.py
0ce6775 
Added reference where omega_ideal is used
minor edits e.g. adding `` `` around function arguments
@RDaxini
Update tracking.py
6717ebb
@RDaxini
Update tracking.py
63dc825 
degree->degrees
@RDaxini RDaxini marked this pull request as ready for review September 5, 2024 15:17
kandersolar
kandersolar approved these changes Sep 9, 2024
View reviewed changes
Copy link
Member
@kandersolar kandersolar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if switching all notation etc to match one reference would be a better approach than progressively clarifying the current mix of notation. But I think it's clear that this PR is an improvement over the status quo, so fine with me to merge as is.

@kandersolar kandersolar added this to the v0.11.1 milestone Sep 9, 2024
RDaxini and others added 2 commits September 9, 2024 16:01
@RDaxini @kandersolar
Update pvlib/tracking.py
d4e3749 
Co-authored-by: Kevin Anderson <kevin.anderso@gmail.com>
@RDaxini
linter, one more ``
9c0c962
@kandersolar kandersolar merged commit a14e95e into pvlib:main Sep 9, 2024
30 checks passed
@kandersolar
Copy link
Member

Thanks @RDaxini!

@RDaxini RDaxini deleted the tracking.singleaxis_docs branch September 9, 2024 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cwhanse cwhanse cwhanse approved these changes

@kandersolar kandersolar kandersolar approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
v0.11.1
Development

Successfully merging this pull request may close these issues.
3 participants
@RDaxini @kandersolar @cwhanse
0