Skip to content

Change server parameter to url in get_cams #2463

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

Merged
merged 4 commits into from
May 27, 2025

Conversation

AdamRJensen
Copy link
Member

@AdamRJensen AdamRJensen commented May 26, 2025

  • I am familiar with the contributing guidelines
  • Tests added
  • 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 renames the parameter server in get_cams to url to be consistent with the other iotools.

@AdamRJensen AdamRJensen added the io label May 26, 2025
@AdamRJensen AdamRJensen added the remote-data triggers --remote-data pytests label May 26, 2025
Copy link
Contributor

@echedey-ls echedey-ls left a comment

Choose a reason for hiding this comment

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

LGTM :)

Some other renaming PRs add a test for the deprecation warning when using the old name, but I don't think this is necessary.

Comment on lines 9 to 11
* The ``server`` parameter in :py:func:`~pvlib.iotools.get_cams` has been renamed
to ``url`` to be consistent with the other iotoools.
:pull:`2463`
Copy link
Contributor

@echedey-ls echedey-ls May 26, 2025

Choose a reason for hiding this comment

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

Should be moved to the section down below, "Deprecations" (IMO)

Copy link
Member Author

@AdamRJensen AdamRJensen May 27, 2025

Choose a reason for hiding this comment

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

I agree. It's first when it is completely removed that it should be listed in the "Breaking changes" section.

@AdamRJensen AdamRJensen merged commit 3b35261 into pvlib:main May 27, 2025
24 of 25 checks passed
@AdamRJensen AdamRJensen deleted the change-get_cams-server-to-url branch May 27, 2025 02:57
@kandersolar kandersolar added this to the v0.12.1 milestone May 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
io remote-data triggers --remote-data pytests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants