carpentries / sandpaper-docs

Documentation for The Carpentries Workbench
https://carpentries.github.io/sandpaper-docs/
Other
5 stars 45 forks source link

Update episodes.Rmd #154

Closed ErinBecker closed 1 year ago

ErinBecker commented 1 year ago

Some typo fixes and minor edits for readability. @zkamvar - please let me know if any of these "fixes" are actually wrong, it's entirely possible. 😊

github-actions[bot] commented 1 year 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/sandpaper-docs/compare/md-outputs..md-outputs-PR-154

The following changes were observed in the rendered markdown documents:

 episodes.md | 59 ++++++++++++++++++++++++++++++-----------------------------
 md5sum.txt  |  2 +-
 2 files changed, 31 insertions(+), 30 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 2023-08-03 23:14:06 +0000

ErinBecker commented 1 year ago

I /think/ I've fixed my mistakes this time. 😊 😬

zkamvar commented 1 year ago

Wunderbar! And no worries about the iterations, this is a stumbling block that anyone would have run into. If you don't believe me, consider the fact that The workshop template had a missing closing </script> tag for years: https://github.com/carpentries/workshop-template/pull/792

This is the tradeoff between having blocks denoted by prefixes (clear indication of context, not easy to add/remove blocks) and fences (context-dependent, easy to add/remove blocks).