carpentries-incubator / fair-research-software

A course on tools and practices for open, sustainable and FAIR (Findable, Accessible, Interoperable and Reusable) research software
https://carpentries-incubator.github.io/fair-research-software/
Other
10 stars 5 forks source link

fix issue 123: Consider adding parameterisation as a callout in testing episode #132

Closed kkh451 closed 1 month ago

kkh451 commented 1 month ago

This pull requests closes #123

NOTE!

**Looking at the second commit, formatting changes from opening in RStudio make this appear to have far more changes than actually made.

New callout is added on line 874 in a single block - this is the main change.

github-actions[bot] commented 1 month 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/carpentries-incubator/fair-research-software/compare/md-outputs..md-outputs-PR-132

The following changes were observed in the rendered markdown documents:

 05-code-readability.md |  18 +-
 06-code-testing.md     | 992 ++++++++++++++++++++++++++++---------------------
 links.md               |   9 +
 md5sum.txt             |   6 +-
 4 files changed, 593 insertions(+), 432 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 2024-07-14 20:27:19 +0000