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 typechecking of docs/examples to ci #174

Open
nclack opened this issue Mar 5, 2024 · 1 comment
Open

add typechecking of docs/examples to ci #174

nclack opened this issue Mar 5, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation testing A testing gap

Comments

@nclack
Copy link
Member

nclack commented Mar 5, 2024

In #171, there was a problem with type-checking exposed when a user tried to use the documented examples. This got fixed in #173 but exposed a testing gap.

We type-check in CI, but this doesn't test whether the types get exposed correctly. That should get fixed.

@tlambert03
Copy link
Contributor

I was also gonna suggest perhaps extracting the code blocks and executing them as well. I ran into some issues running through the docs with new chunking apis.

I'll see if I can do that in a PR :)

@aliddell aliddell moved this from Backlog to Complete in Image Acquisition Team Board Mar 11, 2024
@aliddell aliddell moved this from Complete to Backlog in Image Acquisition Team Board Mar 11, 2024
@aliddell aliddell added bug Something isn't working documentation Improvements or additions to documentation testing A testing gap and removed bug Something isn't working labels Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation testing A testing gap
Projects
Status: Backlog
Development

No branches or pull requests

3 participants