added instructor notes to address #240

[JasonJWilliamsNY]

Added to the instructor notes. ALSO - I note that there is a weird bug in the rendering of the callout. If It didn't include a H3 heading in the tip box ('###') and accounting for line breaks, the paragraph under the callout title was also considered H2 when rendered. Maybe @zkamvar may have a look some day

[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/datacarpentry/genomics-r-intro/compare/md-outputs..md-outputs-PR-310

The following changes were observed in the rendered markdown documents:

 instructor-notes.md | 14 +++++++++++++-
 md5sum.txt          |  2 +-
 2 files changed, 14 insertions(+), 2 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 2025-02-19 17:00:55 +0000

[zkamvar]

That blank heading thing is definitely weird. It's in @froggleston and @ErinBecker's respective courts. I would recommend they check the output of sandpaper:::render_html() to see what is up. https://carpentries.github.io/sandpaper/reference/render_html.html

[naupaka]

@froggleston can I merge this PR? Maybe I could open a new issue to track this rendering bug and link to the merged PR?

[froggleston]

When using @JasonJWilliamsNY version with the additional ###, I get an error with the build:

── Creating Instructor Notes ────────────────────────────────────────────
Error in `xml_attr<-.xml_node`(dots[[1L]][[1L]], attr = dots[[2L]][[1L]],  :
  CHAR() can only be applied to a 'CHARSXP', not a 'NULL'

When removing it and leaving the usual H2 block, the callout renders successfully:

Could you paste your sessionInfo() @JasonJWilliamsNY so I can compare what package versions we have? I'm not able to reproduce this here.

[JasonJWilliamsNY]

I'll suppose I'll have a go at that...