Repository navigation
Move repeated WKT POINT formatting in iotools.psm4 into tools helper - #2948
Open
MoxOmega88 wants to merge 2 commits into
Open
MoxOmega88 wants to merge 2 commits into
MoxOmega88 wants to merge 2 commits into
Conversation
Hey @MoxOmega88! 🎉Thanks for opening your first pull request! We appreciate your If AI is used for any portion of this PR, you must vet the content Finally, be sure the PR description includes the PR |
Member
|
Some useful cleanup here. I don't think a whatsnew note is needed, since it's improving some internal code with no change to output. |
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
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.
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.Each of the six
get_nsrdb_psm4_*functions inpvlib/iotools/psm4.pyrepeated the same block to format the request location as a well-known text (WKT) POINT, along with the comment# TODO: make format_WKT(object_type, *args) in tools.py(and a "well know text" typo).This PR resolves that TODO:
pvlib.tools._format_wkt_point(latitude, longitude)with a numpydoc docstring.psm4.pywith calls to the helper (net -42 lines inpsm4.py).tests/test_tools.py, including a test asserting the helper returns exactly the same string as the previous inline formatting.There is no change in behaviour: the
wktquery parameter sent to the NSRDB API is identical for all six functions. I kept the helper specific to POINT rather than the more generalformat_WKT(object_type, *args)suggested in the TODO, since POINT is the only geometry pvlib currently uses. Happy to generalize it if preferred.