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

Add debug term to glossary #1091

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Add debug term to glossary #1091

merged 1 commit into from
Dec 3, 2024

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented Dec 3, 2024

If this pull request addresses an open issue on the repository, please add 'Closes #NN' below, where NN is the issue number.
N/A

Please briefly summarise the changes made in the pull request, and the reason(s) for making these changes.

In the carpentries glosario repo it was raised that it could be helpful for some learners to include the definition of "debug".

This PR adds the "debug" term to the glossary, using a shorter variant of the definition given in glosario

If any relevant discussions have taken place elsewhere, please provide links to these.

The suggestion comes from issue #384 in the glosario repo

For more guidance on how to contribute changes to a Carpentries project, please review the Contributing Guide and Code of Conduct.

Please keep in mind that lesson Maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at [email protected].

In the carpentries glossary repo it was raised that it could be helpful for some learners to include the definition of debug here ([issue swcarpentry#384](carpentries/glosario#384))
Copy link

github-actions bot commented Dec 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/python-novice-inflammation/compare/md-outputs..md-outputs-PR-1091

The following changes were observed in the rendered markdown documents:

 md5sum.txt   | 2 +-
 reference.md | 4 ++++
 2 files changed, 5 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-12-03 12:00:46 +0000

@sfmig sfmig marked this pull request as ready for review December 3, 2024 10:56
Copy link
Member

@ineelhere ineelhere left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the addition!

github-actions bot pushed a commit that referenced this pull request Dec 3, 2024
@ineelhere ineelhere merged commit b398361 into swcarpentry:main Dec 3, 2024
3 checks passed
github-actions bot pushed a commit that referenced this pull request Dec 3, 2024
Auto-generated via `{sandpaper}`
Source  : b398361
Branch  : main
Author  : Indraneel Chakraborty <[email protected]>
Time    : 2024-12-03 12:01:32 +0000
Message : Merge pull request #1091 from sfmig/patch-1

Add debug term to glossary
github-actions bot pushed a commit that referenced this pull request Dec 3, 2024
Auto-generated via `{sandpaper}`
Source  : 3728bd8
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-12-03 12:02:12 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : b398361
Branch  : main
Author  : Indraneel Chakraborty <[email protected]>
Time    : 2024-12-03 12:01:32 +0000
Message : Merge pull request #1091 from sfmig/patch-1

Add debug term to glossary
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