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

Make several undocumented functions private #1769

Merged
merged 15 commits into from
Jun 23, 2023

Conversation

kandersolar
Copy link
Member

@kandersolar kandersolar commented Jun 12, 2023

  • Goes some way to addressing Functions to consider making private #1756
  • 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.

This PR changes three things:

  • Move pvlib.spa.calculate_deltat to pvlib.solarposition.calculate_deltat, since the calculation it implements is not part of the SPA
  • Rename pvlib.spa to pvlib._spa to make the whole module private, since none of the remaining functions are intended to be used directly
  • Rename the undocumented functions in Functions to consider making private #1756 to be private

@kandersolar kandersolar added this to the 0.10.0 milestone Jun 12, 2023
@kandersolar kandersolar changed the title Make pvlib.spa and several other functions private Make several undocumented functions private Jun 20, 2023
@kandersolar kandersolar added the remote-data triggers --remote-data pytests label Jun 20, 2023
@kandersolar kandersolar merged commit 14041cc into pvlib:main Jun 23, 2023
@kandersolar kandersolar deleted the privatize branch June 23, 2023 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api remote-data triggers --remote-data pytests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants