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 notebooks for docs #175

Merged
merged 8 commits into from
Oct 21, 2024
Merged

Run notebooks for docs #175

merged 8 commits into from
Oct 21, 2024

Conversation

N-Wouda
Copy link
Owner

@N-Wouda N-Wouda commented Oct 21, 2024

This PR:

Notes:

  • It is essential that you add a test when making code changes.
    This keeps the code coverage level up, and helps ensure the changes work as intended.
  • When fixing a bug, you must add a test that would produce the bug in the master branch, and then show that it is fixed with the new code.
  • New code additions must be well formatted. Changes should pass the pre-commit workflow, which you can set up locally using pre-commit.
  • Docstring additions must render correctly, including escapes and LaTeX.

Copy link

codecov bot commented Oct 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.46%. Comparing base (b53c225) to head (8c74516).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #175   +/-   ##
=======================================
  Coverage   99.46%   99.46%           
=======================================
  Files          30       30           
  Lines         748      748           
=======================================
  Hits          744      744           
  Misses          4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@N-Wouda N-Wouda requested a review from leonlan October 21, 2024 10:33
Copy link
Collaborator

@leonlan leonlan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

docs/README.md Outdated Show resolved Hide resolved
@N-Wouda N-Wouda merged commit 909e09f into master Oct 21, 2024
8 checks passed
@N-Wouda N-Wouda deleted the run-notebooks-for-docs branch October 21, 2024 11:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Run example notebooks in CI
2 participants