docs: only use type annotations for documentation - #1709
Merged
Conversation
nejch
marked this pull request as draft
November 24, 2021 20:07
Member
|
Looks cool! Thanks for this. I'll review once you mark it ready for review. |
nejch
force-pushed
the
docs/sphinx-annotations
branch
from
November 28, 2021 17:41
e262867 to
af0cb4d
Compare
Member
Author
|
Turns out I was just using an outdated external module but it's now part of |
nejch
marked this pull request as ready for review
November 28, 2021 17:43
JohnVillalovos
approved these changes
Nov 29, 2021
JohnVillalovos
left a comment
Member
There was a problem hiding this comment.
I'm okay to merge it as is.
Thanks for doing this.
JohnVillalovos
approved these changes
Dec 1, 2021
JohnVillalovos
left a comment
Member
There was a problem hiding this comment.
Looks good to me.
Please merge whenever you want to.
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.
We probably still have a lot of incorrect types in the docstrings and this should just take care of it in the future.
Clashes with the internal extension though so needs more work