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

Run Examples in CI #575

Closed
tjlaboss opened this issue Oct 16, 2024 · 1 comment · Fixed by #578
Closed

Run Examples in CI #575

tjlaboss opened this issue Oct 16, 2024 · 1 comment · Fixed by #578

Comments

@tjlaboss
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
Example code is not tested automatically. It can fall out of date without anyone noticing, or it might not run out of the box.

Describe the solution you'd like
During CI, add an example-test that at least makes sure that the examples and demos execute.

Additional context
In #571, a demo does run without manual intervention.

In #559, @MicahGale suggests adding doctest, which is relevant.

@tjlaboss tjlaboss added the CI/CD label Oct 16, 2024
@MicahGale
Copy link
Collaborator

So what's the scope?

  1. README.md
  2. /doc
  3. /demo?

Also most examples are pseudo-code, so this will take a little bit of effort to implement.

@MicahGale MicahGale self-assigned this Oct 22, 2024
@MicahGale MicahGale linked a pull request Oct 22, 2024 that will close this issue
3 tasks
@MicahGale MicahGale mentioned this issue Oct 22, 2024
3 tasks
@MicahGale MicahGale mentioned this issue Oct 30, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants