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

Adding a reference file for this lesson #16

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

Conversation

emcaulay
Copy link

Addresses #5.

I've added a new file (reference.md) in the learners section, so that we can start a glossary. I've added a definition for "sourdough starter", and we can add more definitions as people are able.

Addresses UW-Madison-DataScience#5. 

I've added a new file (reference.md) in the learners section, so that we can start a glossary. I've added a definition for "sourdough starter", and we can add more definitions as people are able.
@github-actions
Copy link

github-actions bot commented Sep 15, 2023

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/UW-Madison-DataScience/github-skillup-2023-09-15/compare/md-outputs..md-outputs-PR-16

The following changes were observed in the rendered markdown documents:

 md5sum.txt             | 5 +++--
 recipe_instructions.md | 5 -----
 recipe_intro.md        | 8 --------
 reference.md (new)     | 4 ++++
 4 files changed, 7 insertions(+), 15 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 2023-09-15 19:11:57 +0000

@emcaulay
Copy link
Author

Fixes #5.

Comment on lines +1 to +2
title: Reference
## Glossary
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
title: Reference
## Glossary
---
title: Reference
---
## Glossary

The header here has to be wrapped in --- lines (with a blank line after) due to markdown syntax. I need to work on how to make this issue display better as it is rendering that block and hiding the markdown syntax because comments also render markdown. I'll file this as an issue for improving the skill-up.

@sstevens2
Copy link
Contributor

Filed this issue on the lesson since how this issue is displayed needs to be fixed.

github-actions bot pushed a commit that referenced this pull request Sep 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants