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

Modify confusing words and add explanation to git diff with Head #1035

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

Conversation

erinmgraham
Copy link
Contributor

Closes #607

Slight adjustment to the explanation of using git diff with HEAD and previous commits. The original text was great, and I've just rephrased it for clarity and consistency. The new text emphasizes that omitting HEAD doesn't change the command's output and highlights the power of comparing with previous commits using ~1.

Copy link

github-actions bot commented Nov 3, 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-1035

The following changes were observed in the rendered markdown documents:

 05-history.md | 1158 ++++++++++++++++++++++++++++-----------------------------
 md5sum.txt    |    2 +-
 2 files changed, 578 insertions(+), 582 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-11-03 04:16:57 +0000

github-actions bot pushed a commit that referenced this pull request Nov 3, 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.

Confusing wording and lack of explanation on Exploring History Episode
1 participant