added skip options to rail render-nb

[eacharles]

Change Description

• My PR includes a link to the issue that I am addressing

Solution Description

Code Quality

• I have read the Contribution Guide
• My code follows the code style of this project
• My code builds (or compiles) cleanly without any errors or warnings
• My code contains relevant comments and necessary documentation

Project-Specific Pull Request Checklists

Bug Fix Checklist

• My fix includes a new test that breaks as a result of the bug (if possible)
• My change includes a breaking change
  • My change includes backwards compatibility and deprecation warnings (if possible)

New Feature Checklist

• I have added or updated the docstrings associated with my feature using the NumPy docstring format
• I have updated the tutorial to highlight my new feature (if appropriate)
• I have added unit/End-to-End (E2E) test cases to cover my new feature
• My change includes a breaking change
  • My change includes backwards compatibility and deprecation warnings (if possible)

Documentation Change Checklist

• Any updated docstrings use the NumPy docstring format

Build/CI 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

Other Change Checklist

• Any new or updated docstrings use the NumPy docstring format.
• I have updated the tutorial to highlight my new feature (if appropriate)
• I have added unit/End-to-End (E2E) test cases to cover any changes
• My change includes a breaking change
  • My change includes backwards compatibility and deprecation warnings (if possible)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cccd4c8) 95.58% compared to head (f92c1d3) 96.75%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #53      +/-   ##
==========================================
+ Coverage   95.58%   96.75%   +1.17%     
==========================================
  Files          32       32              
  Lines        1629     1632       +3     
==========================================
+ Hits         1557     1579      +22     
+ Misses         72       53      -19     

Files	Coverage Δ
src/rail/cli/options.py	90.47% <100.00%> (+0.23%)	⬆️
src/rail/cli/scripts.py	89.32% <100.00%> (+19.02%)	⬆️

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

[sschmidt23]

It looks like the glob command in test_render_nb wasn't finding anything even before this PR (i.e. much of the test is uncovered in the codecov report for the current main branch). It doesn't look like pyproject.toml includes a dependence on pz-rail, so the glob command returns an empty list. Are there any notebooks available within rail_base to test render? Should we maybe include two very simple notebooks to render for tests (and skip one of those in the tests to test skipping?)

[eacharles]

Thanks for the careful look.  I have to confess I probably ignored the test b/c I was using the command it is supposed to test.   I think a “hello world” nb in the test did is plenty.   The only point is to make sure the command & option are getting to julyter correctly.On Oct 20, 2023, at 5:20 PM, Sam Schmidt ***@***.***> wrote: It looks like the glob command in test_render_nb wasn't finding anything even before this PR (i.e. much of the test is uncovered in the codecov report for the current main branch). It doesn't look like pyproject.toml includes a dependence on pz-rail, so the glob command returns an empty list. Are there any notebooks available within rail_base to test render? Should we maybe include two very simple notebooks to render for tests (and skip one of those in the tests to test skipping?) —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you authored the thread.Message ID: ***@***.***>

[sschmidt23]

Looks good, added two simple notebooks so we could skip one, and added a third line to actually render the hello world notebook, which wasn't being done before. Required adding a jupyter req to the dev requirements, but that seems fairly minimal, so I don't think anyone will object.