Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to the reproducibility section to address #231 #241

Merged
merged 1 commit into from
Aug 16, 2024

Conversation

jcohen02
Copy link
Contributor

@jcohen02 jcohen02 commented Aug 1, 2024

This PR provides various updates to the reproducibility section to address #231.

In the process, some other minor updates and typo fixes have also been made.

Closes #231.

Copy link

github-actions bot commented Aug 1, 2024

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/carpentries-incubator/docker-introduction/compare/md-outputs..md-outputs-PR-241

The following changes were observed in the rendered markdown documents:

 md5sum.txt        |  2 +-
 reproduciblity.md | 39 +++++++++++++++++++++++++++++++++------
 2 files changed, 34 insertions(+), 7 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-01 19:00:28 +0000

@jcohen02 jcohen02 added the peer review:editorial comment Editorial comments to be addressed from the peer review label Aug 1, 2024
github-actions bot pushed a commit that referenced this pull request Aug 1, 2024
Copy link
Contributor

@aturner-epcc aturner-epcc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@aturner-epcc aturner-epcc merged commit 46dbcd2 into carpentries-incubator:main Aug 16, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Aug 16, 2024
Auto-generated via {sandpaper}
Source  : 46dbcd2
Branch  : main
Author  : Andy Turner <a.turner@epcc.ed.ac.uk>
Time    : 2024-08-16 08:20:53 +0000
Message : Merge pull request #241 from jcohen02/fix/issue231

Updates to the reproducibility section to address #231
github-actions bot pushed a commit that referenced this pull request Aug 16, 2024
Auto-generated via {sandpaper}
Source  : 444f6ca
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2024-08-16 08:21:40 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 46dbcd2
Branch  : main
Author  : Andy Turner <a.turner@epcc.ed.ac.uk>
Time    : 2024-08-16 08:20:53 +0000
Message : Merge pull request #241 from jcohen02/fix/issue231

Updates to the reproducibility section to address #231
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
peer review:editorial comment Editorial comments to be addressed from the peer review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve reproducibility text
2 participants