-
Notifications
You must be signed in to change notification settings - Fork 18
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
clean up docstring formatting and type hints #16
Conversation
388ad7d
to
d57555a
Compare
@nicholasloveday and @tennlee, this MR has been rebased with main and is ready to review. |
Thank you very much for all this work. I think we should talk about splitting up the MR into smaller parts, as I think it might take a while to work through the discussion about the right constraints for the type hinting, whereas the other parts of the MR could go ahead without much discussion. |
@aidanjgriffiths some functions specify the type in the docstring (e.g., |
f5256b1
to
28bd6e2
Compare
28bd6e2
to
73b8340
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks very much for this work! I've commented on a few parts which need a little more tweaking before it's done.
Signed-off-by: Aidan Griffiths <[email protected]>
52410f0
to
020d857
Compare
020d857
to
8c5b8db
Compare
8c5b8db
to
72ea4e1
Compare
I have directly discussed readiness of this merge with the author, so I am manually overriding the change request status. Thanks very much for the work! |
* docs: align docstrings with napoleon (google) standards * refactor: replace relative imports with pkg level imports * docs: updating contributing notes to include napoleon docstring style * docs: review amendments to docstrings/types * docs: update coords_increasing check docstring * docs: gather dims union types and mse types --------- Signed-off-by: Aidan Griffiths <[email protected]> Co-authored-by: agriffit <[email protected]>
Tasks
Fix(spun-out into Addmypy
type-hint
issues.mypy
support for type hints #27 )This PR also addresses the relative imports in the
scores.probability
module