swcarpentry / python-novice-inflammation

Programming with Python
http://swcarpentry.github.io/python-novice-inflammation/
Other
303 stars 781 forks source link

Add in range_overlap changes from @DamienIrving #1072

Closed tmorrell closed 10 months ago

tmorrell commented 1 year ago

This pull requests extracts a small portion of the changes from https://github.com/swcarpentry/python-novice-inflammation/pull/981 and updates them to the workbench format. All the text is from @DamienIrving

The motivation to add this change separately is currently the range_overlap exercise ends partly through without providing a actual solution. These changes provide the final solution and a much better walkthrough, and are independent from the discussion of exceptions and assertions.

github-actions[bot] commented 1 year ago

Thank you!

Thank you for your pull request :smiley:

:robot: This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

Rendered Changes

:mag: Inspect the changes: https://github.com/swcarpentry/python-novice-inflammation/compare/md-outputs..md-outputs-PR-1072

The following changes were observed in the rendered markdown documents:

 10-defensive.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 md5sum.txt      |  2 +-
 2 files changed, 68 insertions(+), 3 deletions(-)
What does this mean? If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

:stopwatch: Updated at 2023-11-10 14:19:01 +0000

tmorrell commented 1 year ago

Thanks @ineelhere. My motivation for splitting up the contents of #981 was to make it easier to merge. The changes to range_overlap are really independent of everything else in #981, and I think others should propose/promote the change from exceptions to assertions.