Remove deprecated spectrum.get_am15g function
#2409
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RDaxini
reviewed
Mar 14, 2025
Comment on lines
+15
to
+16
| * Remove deprecated :py:func:`!pvlib.spectrum.get_am15g` function; use | ||
| :py:func:`~pvlib.spectrum.get_reference_spectra` instead. (:pull:`2409`) |
There was a problem hiding this comment.
Suggested change
| * Remove deprecated :py:func:`!pvlib.spectrum.get_am15g` function; use | |
| :py:func:`~pvlib.spectrum.get_reference_spectra` instead. (:pull:`2409`) | |
| * Remove deprecated :py:func:`~pvlib.spectrum.get_am15g` function; use | |
| :py:func:`~pvlib.spectrum.get_reference_spectra` instead. (:pull:`2409`) |
What does the ! do? Should it be a ~?
There was a problem hiding this comment.
I only learned about ! recently, I think from one of @echedey-ls's PRs if I remember correctly. From https://www.sphinx-doc.org/en/master/usage/referencing.html:
Prefixing with an exclamation mark (!) prevents the creation of a link but otherwise keeps the visual output of the role.
a tilde ~ prefix shortens the link text to the last component of the target.
We're getting rid of get_am15g, so there's no point in trying to link somewhere, but it would be nice (IMHO) to have the same function formatting applied regardless.
echedey-ls
approved these changes
Mar 14, 2025
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[ ] Closes #xxxxdocs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor 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`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.This PR removes the
get_am15gfunction, which was deprecated in v0.11.0 when we added the more generalget_reference_spectrafunction.