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.

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

Issue #1697 Remove the function and all its reference poa_horizontal_ratio. #2021

Merged
merged 3 commits into from
May 24, 2024
Merged

Issue #1697 Remove the function and all its reference poa_horizontal_ratio. #2021

merged 3 commits into from
May 24, 2024

Conversation

k10blogger
Copy link
Contributor

@k10blogger k10blogger commented Apr 28, 2024

This pull requests removes the poa_horizontal_ration with all its reference in the documentation and examples.

  • Closes pvlib.irradiance.poa_horizontal_ratio should be removed #1697
  • I am familiar with the contributing guidelines
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in 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`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

@kandersolar kandersolar added this to the 0.11.0 milestone Apr 29, 2024
@kandersolar
Copy link
Member

Does this function deserve a deprecation period before removal? I lean towards no. I doubt it gets much use at all, and anyone who is using it can easily calculate the quantity themselves. But I do think we should at least remove it in a .0 release, so I've tagged this PR for 0.11.0.

Thanks @k10blogger for the PR!

@cwhanse
Copy link
Member

cwhanse commented Apr 29, 2024

Concur with no deprecation and v0.11.0

@AdamRJensen
Copy link
Member

@k10blogger this looks good. Could you add a whatsnew entry in v0.11.0?

@cwhanse
Copy link
Member

cwhanse commented May 24, 2024

@pvlib/pvlib-maintainer whatsnew used to have "API changes". We dropped that when we switched to "Breaking changes" and "Deprecations" and now I'm not sure where we list a function that's been dropped.

Should we add a section to whatsnew titled "Removals"?

Edit: or list the removal under "Deprecations"?

@kandersolar
Copy link
Member

I've understood "Deprecations" to be new deprecations, i.e. usage that now emits a deprecation warning but didn't before, and "Breaking changes" to be functionality that was removed entirely. I'd put the entry for this PR under "Breaking changes".

@cwhanse cwhanse added the api label May 24, 2024
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.

Thanks @k10blogger!

@kandersolar kandersolar merged commit eeec98c into pvlib:main May 24, 2024
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pvlib.irradiance.poa_horizontal_ratio should be removed
4 participants