rules: fix sphinx auto-doc warning and mypy error #2238
Merged
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
Exirel
added
Documentation
Bugfix
dgw
approved these changes
Jan 18, 2022
Member
dgw
left a comment
dgw
left a comment
There was a problem hiding this comment.
Just let me know once squashed. I'm guessing you will because of the "fix" commit message. 😁
4 tasks
It appears that Sphinx's autodoc plugin doesn't understand TypeVar properly: it doesn't generate documentation, and it doesn't understand it when used in a function's signature. To fix that warning for now, a fake class declaration is written in the documentation. I added a TODO for when Sphinx fixes that problem.
Exirel
force-pushed
the
rules-fix-docs-mypy-warnings
branch
from
216c0c9 to
9144a0b
Compare
Contributor
Author
|
And done! |
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.
Description
Tin: I fixed two warning/error:
typing.TypeVar, so I created a class declaration for the one used inplugins.rules,mypydoesn't like that so I fixed that as well, given it's inplugins.handlersTwo quick fixes.
Checklist
make qa(runsmake qualityandmake test)