Skip to content

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

Merged
kandersolar merged 3 commits into
pvlib:mainfrom
k10blogger:master
May 24, 2024
Merged

Issue #1697 Remove the function and all its reference poa_horizontal_ratio.#2021
kandersolar merged 3 commits into
pvlib:mainfrom
k10blogger:master

Conversation

@k10blogger

@k10blogger k10blogger commented Apr 28, 2024

Copy link
Copy Markdown
Contributor

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
Copy Markdown
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

cwhanse commented Apr 29, 2024

Copy link
Copy Markdown
Member

Concur with no deprecation and v0.11.0

@AdamRJensen

Copy link
Copy Markdown
Member

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

@cwhanse

cwhanse commented May 24, 2024

Copy link
Copy Markdown
Member

@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
Copy Markdown
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

@kandersolar kandersolar left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @k10blogger!

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