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

Adds callout to introduce Markdown #1018

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pgmccann
Copy link
Contributor

@pgmccann pgmccann commented Oct 2, 2024

Borrows heavily from https://github.com/swcarpentry/python-novice-gapminder/blob/2aef01ba47cbf88e9c607f920b83b7dc59d7044e/episodes/01-run-quit.md. Requires update to varnish so that table within callout is styled properly.

I'm not fully across the new lesson platform, so I'm not entirely clear how to update varnish for local testing with my fork of this lesson.

Copy link

github-actions bot commented Oct 2, 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/swcarpentry/git-novice/compare/md-outputs..md-outputs-PR-1018

The following changes were observed in the rendered markdown documents:

 04-changes.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 md5sum.txt    |  2 +-
 2 files changed, 51 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-10-02 13:42:00 +0000

github-actions bot pushed a commit that referenced this pull request Oct 2, 2024
@martinosorb
Copy link
Contributor

Hi @pgmccann, I have a few concerns: it's a large table that may be a bit bulky here. I am not sure if the "callout" actually works due to Varnish, as you say (I remember working on this on the python-novice-gapminder side). Lastly, there is no introduction to it: it should be put in context and explained why we are showing this table through an introduction to what markdown is.

@martinosorb martinosorb added the status:changes requested Waiting for Contributor to update PR label Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:changes requested Waiting for Contributor to update PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants