Add an inline Instructor Note warning about different flag behaviour

[tobyhodges]

The general Instructor Notes mention that

grep -E on macOS X acts like grep -P on other platforms. On Windows and Linux, grep -E is halfway between grep -P and grep: it only does what grep can do, but uses Perl-compatible syntax to do it.

This pull request adds an inline Instructor Note to display this information next to the exercise where this confusion is most likely to be encountered.

[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/LibraryCarpentry/lc-shell/compare/md-outputs..md-outputs-PR-284

The following changes were observed in the rendered markdown documents:

 05-counting-mining.md | 10 ++++++++++
 md5sum.txt            |  2 +-
 2 files changed, 11 insertions(+), 1 deletion(-)

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-11-07 15:15:20 +0000

[kaitlinnewson]

Since this is referring to the next section, it would make sense to move this into that section (as an H3 under the next H2). Right now this positions it as a heading under the previous solution that it isn't related to.

[tobyhodges]

Thanks for the review @kaitlinnewson. To make sure that I understand correctly: you would prefer the instructor note to appear inside the challenge block it refers to, rather than above it?