Add some notes on usage examples and conventions

[Joe-Heffer-Shef]

No description provided.

[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/Joe-Heffer-Shef/FAIR4RS-Documentation/compare/md-outputs..md-outputs-PR-35

The following changes were observed in the rendered markdown documents:

 docstrings.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++--
 md5sum.txt    |  2 +-
 2 files changed, 51 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.

⏱️ Updated at 2024-08-06 08:47:43 +0000