Execute the README examples during the pre-deployment checks

Question

Execute the README examples during the pre-deployment checks

elsoroka opened this issue 2 months ago · 2 comments

Twice now (#48, #47) there has been trouble with the README examples. This is difficult to catch in an automated way because the README code isn't run in ci.yaml. Making sure the examples run and produce the expected output would prevent these errors from being merged.

Answer 1 · 2024-06-17T00:14:34.000Z

Also per JOSS reviewers, the examples in the documentation can be automatically tested by Documenter.jl which needs to be set up.

Answer 2 · 2024-07-13T23:39:22.000Z

Closed by @rafaelbailo in #54