-
Notifications
You must be signed in to change notification settings - Fork 25
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
Docstring improvements #245
Docstring improvements #245
Conversation
Everything seems ready to go (all tests passing), except CodeCov. |
Unrelated to docstring update: Since I am a bit of a perfectionist having the CodeCov failure bothered me. To address it, I looked at the coverage report and saw that the logic to catch uninitialized plugins (throws an AttributeError) was un-tested. I decided to write a test to capture this, but in doing so, realized that the exception-handling logic was flawed! If one passes in an uninitialized plugin, instead of making it to the try/except block, an AttributeError will be thrown as the I expanded the try/except block to contain both the All checks passing now 😄 @abkfenris |
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 for chasing down all the types and cleaning up the documentation! There are a few small things, one being a place where we likely had the typing wrong before.
Closes #186
@abkfenris I will be a free-agent in a week or two, and plan to contribute in this ecosystem more heavily. I figured documenting and type-hinting the codebase would be an opportunity to refresh on the inner-workings.
Changes:
pydocstyle
to ourpyproject.toml
. This includes docstring formatting as part of the pre-commit. I have it set to ignore the tests/ and docs/ directories as that seems fussy, but I am happy to cover those two as well.pyright
to make check that all typehints are correct, and fixed some bad ones.pyright
best practices. No changes to logic.pre-commit
to the dev environment requirements.txt.