chore: added generic type hints to several more modules + docstring cleanup. #379
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Problem
Continuation of the work started on #377 of adding generic type hints to the Gazu codebase - more information can be found on that PR and linked discussion.
Solution
This PR adds type hints to several more of the modules - there should be one more incoming soon typing the remaining modules (they've been split out to ease development and review).
As with the last PR, along the way I've also made some minor fixes/additions to docstrings, in cases where I didn't find the types or behaviours of the arguments immediately obvious - or there was incorrect/missing info in the docstrings.
I've also standardised model parameter docstrings from
dict / IDtostr / dictin a couple of places so they're all the same.