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

Fix broken examples #753

merged 2 commits into from Aug 17, 2019

Fix broken examples #753

merged 2 commits into from Aug 17, 2019


Copy link

@dmontagu dmontagu commented Aug 16, 2019

Change Summary

Fixes a handful of broken examples in the docs, and adds a make recipe test-examples that can be used to identify which examples are broken.

Some of them explicitly claim they will error, so I didn't set up any sort of pass/fail test, and didn't add the recipe to any of the CI or similar. But at least with this recipe you can quickly get a list of the failures and confirm there are no surprises.

I suppose we could add validation that the failures are the exact files we expect, but I figured I'd keep this change small.


  • Unit tests for the changes exist
    N/A ?

  • Tests pass on CI and coverage remains at 100%

  • Documentation reflects the changes where applicable

  • changes/<pull request or issue id>-<github username>.rst file added describing change
    (see changes/ for details)

Copy link

@codecov codecov bot commented Aug 16, 2019

Codecov Report

Merging #753 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master   #753   +/-   ##
  Coverage     100%   100%           
  Files          15     15           
  Lines        2723   2723           
  Branches      536    536           
  Hits         2723   2723

@samuelcolvin samuelcolvin merged commit 27bb336 into samuelcolvin:master Aug 17, 2019
10 checks passed
Copy link

@samuelcolvin samuelcolvin commented Aug 17, 2019

thanks, as you say I think we should run all example scripts in CI.

The simplest way of denoting if they should fail would be either to include --ValidationError indicating the error they should fail with in the file name. There are a few other options, but that seems simplest.

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

Successfully merging this pull request may close these issues.

None yet

2 participants