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 the tutorial plotting code in doctests #1374

Merged
merged 1 commit into from
Jan 16, 2024
Merged

Conversation

bhazelton
Copy link
Member

@bhazelton bhazelton commented Jan 9, 2024

Description

Ensure that the plotting commands in the tutorial are actually run in the doctests. Recently a bug was discovered in the plotting code because it wasn't being tested (see #1336).

Also include the generated plots in the docs for completeness.

See the RTD build to see what the docs will look like.

Motivation and Context

Fixes #1339

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change (documentation changes only)
  • Version change
  • Build or continuous integration change

Checklist:

Documentation change checklist:

  • Any updated docstrings use the numpy docstring format.
  • If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. (you may need help to get this branch to build on RTD, just ask!)

Build or continuous integration change checklist:

  • If required or optional dependencies have changed (including version numbers), I have updated the readme to reflect this.
  • If this is a new CI setup, I have added the associated badge to the readme and to references/make_index.py (if appropriate).

To prevent bugs in the plotting code.
Also include the plots in the docs.
Copy link

codecov bot commented Jan 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e0ff8db) 99.92% compared to head (57ade93) 99.92%.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1374   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files          36       36           
  Lines       20249    20249           
=======================================
  Hits        20233    20233           
  Misses         16       16           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e0ff8db...57ade93. Read the comment docs.

Copy link
Member

@mkolopanis mkolopanis left a comment

Choose a reason for hiding this comment

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

seems pretty reasonable to me. Thanks for making sure all the images look the same too.

@mkolopanis mkolopanis merged commit f1d8de2 into main Jan 16, 2024
53 checks passed
@mkolopanis mkolopanis deleted the test_tutorial_plotting branch January 16, 2024 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Don't skip the plotting commands in tutorial testing
2 participants