srstevenson / nb-clean

Clean Jupyter notebooks of outputs, metadata, and empty cells, with Git integration
https://pypi.org/project/nb-clean/
ISC License
128 stars 18 forks source link

Document command line flag corner cases more clearly #254

Closed DanielTsiang closed 5 months ago

DanielTsiang commented 5 months ago

Make README.md clearer.

Changes:

DanielTsiang commented 5 months ago

Might want to hold off merging this PR in actually until this bug is resolved:

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (a7b8f57) 99.46% compared to head (4b71789) 99.46%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #254 +/- ## ======================================= Coverage 99.46% 99.46% ======================================= Files 3 3 Lines 187 187 ======================================= Hits 186 186 Misses 1 1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

srstevenson commented 5 months ago

Thanks, @DanielTsiang, this makes things clearer! I've added a commit to give more detailed instructions about avoiding the issue you experienced in #255. Note I reverted your change to the nb-clean 1.6.0 column in the migration table: in 1.6.0, the notebook path was passed with the --input flag and not as a positional argument, so can't be moved to the end of the command line.

DanielTsiang commented 5 months ago

Thanks for correcting the PR!

The README.md is a lot clearer now so hopefully a lot more people will feel comfortable using this tool in the future! 🙂