Regression testing module improvements

[avadean]

Overhaul of the regression testing module

• Introduction gives motivation and explanation
• Manual example
• Snaptol example
• Snaptol with floating point number tolerance example
• 3 exercises of increasing difficulty

Fixes #4

[github-actions]

Thank you!

Thank you for your pull request 😃

🤖 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:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/ResearchCodingClub/python-testing-for-research/compare/md-outputs..md-outputs-PR-19

The following changes were observed in the rendered markdown documents:

 09-testing-output-files.md | 469 +++++++++++++++++++++++++++++++++------------
 md5sum.txt                 |   2 +-
 2 files changed, 343 insertions(+), 128 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.

⏱️ Updated at 2026-02-17 15:59:19 +0000

[LiamPattinson]

Thanks @avadean, this all looks good to me!