Add scripts for type-checking rst doc files and Jupyter notebooks#769
Open
Add scripts for type-checking rst doc files and Jupyter notebooks#769
Conversation
Member
|
This feature seems useful, but I'm worried about maintenance burden of an extra script. @ernestum what do you think? https://github.com/nbQA-dev/nbQA looks like it can run mypy on notebooks so that might be one more maintainable way of getting some type checking, but that wouldn't solve the rst doc file problem. EDIT: I see this is actually using nbqa, I think we can probably simplify that Python script using it, might be easier as a shell script. |
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
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
Here are two scripts I used for checking for type errors in documentation and notebooks. I don't know whether this is of use to anyone. So I figured I'll open a PR and see..
Limitations
There are currently some false positives from documentation code blocks which contain ellipses like
# instantiate your policy here. Just ignore these or fix them in case you'd like to include these scripts in CI.Testing
Manually introducing type errors and running the scripts.