Skip to content

Ensure example works #236

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

Merged
merged 1 commit into from
Nov 10, 2023
Merged

Ensure example works #236

merged 1 commit into from
Nov 10, 2023

Conversation

simolus3
Copy link
Contributor

A working example is helpful for users getting started with this package, so that they can take code known to work as a starting point.

This adds documentation comments to the example explaining how to run it. It also fixes the statements to set everything up, meaning that the example can now be run. To ensure future changes don't break the example, I've added a CI step running it.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2684dc6) 86.25% compared to head (f8ba6b8) 86.25%.
Report is 1 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #236   +/-   ##
=======================================
  Coverage   86.25%   86.25%           
=======================================
  Files          34       34           
  Lines        2924     2924           
=======================================
  Hits         2522     2522           
  Misses        402      402           

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

@isoos isoos merged commit 4d54e6f into isoos:master Nov 10, 2023
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.

3 participants