Type hint for DataFrame #103
Merged
Conversation
This file contains 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
This is sufficient for Pyright to infer the complete return type for (at least) nwis.get_info and nwis.get_iv. DOI-USGS#97
|
I'm fine with this type of type hinting, thank you for also providing those screenshots @davetapley, helps me understand where this is helpful -- otherwise I'd have likely asked why this is more useful than the typing specified in the doc-string immediately below the function. What do you think @thodson-usgs ? |
thodson-usgs
approved these changes
Jun 5, 2023
There was a problem hiding this comment.
Yes, I'd accept type-hinting PR's, though we should encourage a standard style.
I don't see it causing a problem in this case, but eventually we may need to modify the import section in order for type hinting work with our build process. The details are hazy, but I'll fix it when that occurs.
|
Primarily, type-hinting makes the linter aware of what objects are. |
Co-authored-by: Timothy Hodson <34148978+thodson-usgs@users.noreply.github.com>
Open
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.
Before:
After:
#97