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

changes md symbol used for listing items #1012

Closed
wants to merge 1 commit into from

Conversation

dpshelio
Copy link
Contributor

This is something that I always forget and only remember when I'm teaching it and encountered as recently @krishnakumarg1984 reminded me.

Markdown accepts either - or * however, in this material, the -
causes confusion when looking at diffs as you'd get things like:

 - avocado
-- lemon
+- lime

making the - from the diff misunderstood with the - of the list.

Markdown accepts either `-` or `*` however, in this material, the `-`
causes confussion when looking at diffs as you'd get things like:

```diff
 - avocado
-- lemon
+- lime
```

making the `-` from the diff misunderstood with the `-` of the list.
github-actions bot pushed a commit that referenced this pull request Aug 14, 2024
Copy link

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-1012

The following changes were observed in the rendered markdown documents:

 02-setup.md                          |  12 +-
 03-create.md                         |  88 +++++----
 04-changes.md                        | 238 +++++++++++++------------
 05-history.md                        | 335 +++++++++++++++++++++--------------
 06-ignore.md                         | 100 +++++------
 07-github.md                         |  86 +++++----
 08-collab.md                         |  44 ++---
 09-conflict.md                       | 244 +++++++++++++++----------
 12-citation.md                       |  28 ++-
 13-hosting.md                        |   3 +-
 14-supplemental-rstudio.md           |   8 +-
 discuss.md                           | 130 +++++++-------
 fig/git-freshly-made-github-repo.svg |   4 +-
 fig/git_staging.svg                  |   2 +-
 fig/github-add-collaborators.png     | Bin 100892 -> 232665 bytes
 fig/github-collaboration.svg         |  10 +-
 fig/github-repo-after-first-push.svg |   6 +-
 index.md                             |   8 +-
 instructor-notes.md                  |   8 +-
 md5sum.txt                           |  28 +--
 20 files changed, 771 insertions(+), 611 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 2024-08-14 16:11:42 +0000

@tobyhodges
Copy link
Member

I am a big fan of this suggested change! 🎉

@dpshelio dpshelio mentioned this pull request Aug 14, 2024
5 tasks
@dpshelio
Copy link
Contributor Author

It's included into #1013 to avoid conflicts.

@dpshelio dpshelio closed this Aug 14, 2024
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