search

acquire-project / acquire-python

Acquire: a multi-camera video streaming software focusing on microscopy
Apache License 2.0
18 stars 9 forks source link

add typechecking of docs/examples to ci #174

Open nclack opened 8 months ago

nclack commented 8 months ago

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 commented 8 months ago

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 :)