Skip to content
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

Add scripts for type-checking rst doc files and Jupyter notebooks #769

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jas-ho
Copy link
Contributor

@jas-ho jas-ho commented Aug 10, 2023

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.

@jas-ho jas-ho requested a review from AdamGleave August 10, 2023 15:02
@AdamGleave
Copy link
Member

AdamGleave commented Aug 10, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants