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

Consistently use underscores instead of hyphens in filenames #133

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

Conversation

SJaffa
Copy link
Contributor

@SJaffa SJaffa commented Aug 12, 2024

Closes #115

This is a work in progress, I need to check through later lessons for consistency.

We currently have underscores in Python and PNG filenames but hyphens in data files (JSON and CSV). Should we use underscores in filenames throughout to avoid extra cognitive load?

Copy link

github-actions bot commented Aug 12, 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/carpentries-incubator/fair-research-software/compare/md-outputs..md-outputs-PR-133

The following changes were observed in the rendered markdown documents:

 04-version-control.md | 34 +++++++++++++++++-----------------
 md5sum.txt            |  2 +-
 2 files changed, 18 insertions(+), 18 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-12 10:56:43 +0000

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

Avoid dashes in Python module names
1 participant