Overhaul of the regression testing module

[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

[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-11

The following changes were observed in the rendered markdown documents:

 00-introduction.md                                 |   8 +-
 01-why-test-my-code.md                             | 148 +++----
 02-simple-tests.md                                 | 168 +++++---
 03-interacting-with-tests.md                       |  61 ++-
 04-unit-tests-best-practices.md                    |  72 ++--
 05-testing-exceptions.md                           |   8 +-
 06-floating-point-data.md (gone)                   | 282 ------------
 06-testing-data-structures.md (new)                | 471 +++++++++++++++++++++
 07-fixtures.md                                     | 287 ++++++-------
 08-parametrization.md                              | 183 ++++----
 09-testing-output-files.md                         | 469 ++++++++++++++------
 10-CI.md                                           | 347 ++++-----------
 CODE_OF_CONDUCT.md                                 |   2 -
 LICENSE.md                                         |   7 +-
 files/07-fixtures/statistics/stats.py              | 104 +++++
 files/07-fixtures/statistics/test_stats.py         |  54 +++
 files/08-parametrization/statistics/stats.py       | 104 +++++
 files/08-parametrization/statistics/test_stats.py  |  54 +++
 files/09-testing-output-files/statistics/stats.py  | 104 +++++
 .../statistics/test_stats.py                       |  55 +++
 md5sum.txt                                         |  30 +-
 setup.md                                           |  52 +--
 22 files changed, 1868 insertions(+), 1202 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:44:56 +0000

[LiamPattinson]

Thanks @avadean! Just leaving a few comments for now, as I'll be working on a bunch of my own material over the weekend which will inform the final review. I'm close to finishing a lesson on floating point numbers which might help simplify some of the content here.