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

Fix typo in cutting call out #1643

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix typo in cutting call out #1643

wants to merge 4 commits into from

Conversation

brownsarahm
Copy link
Contributor

attempts to fix #1642

I did something slightly different than the suggestion, but i agree there was a typo in the box.

I think leaving it at the top actually makes sense for two reasons:

  1. in theory, trainees are coming back to this page as a reference after the workshop more often than reading it when they would not know what we mean by cutting, and having a warning at the top of the episode that the version they saw in their workshop may have been truncated
  2. it serves as an additional reminder to trainers that this episode is a good place to make up time if needed. While a trainer would see the entirety of the episode while preparing, I think at the top it is more likely to catch & support in real time a new trainer who might be nervous; that is the note to cut from this episode and reassurance that others cut here too, could help prevent someone from speeding up instead of cutting, but for that to work, the reminder has to be before the content that would be cut.

If others 1) agree with that rationale 2) think it is worth making more findable, we could put a (shortend; edited for clarity) version of that justification in the box too.

Copy link

github-actions bot commented Feb 22, 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/instructor-training/compare/md-outputs..md-outputs-PR-1643

The following changes were observed in the rendered markdown documents:

 18-preparation.md | 12 ++++++++++--
 md5sum.txt        |  2 +-
 2 files changed, 11 insertions(+), 3 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-06-04 15:56:46 +0000

@brownsarahm brownsarahm changed the title rephrase to resolve typo Fix typo in cutting call out Feb 22, 2024
github-actions bot pushed a commit that referenced this pull request Feb 22, 2024
Copy link
Contributor

@ndporter ndporter left a comment

Choose a reason for hiding this comment

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

Agree this is an improvement and addresses the most important parts of the issue. My only question is whether this should be an instructor note (e.g. trainer note) instead of a callout? That is, should everyone who goes to the lesson see it or only if they're using instructor mode?

@brownsarahm
Copy link
Contributor Author

That is a good point, actually with instructor view, maybe we do audience specific versions approximately like:

  • for trainers: this is a place you may want to cut ...
  • for trainees: this episode may have more detail in it that was covered in your works ...

github-actions bot pushed a commit that referenced this pull request Jun 4, 2024
Separate instuctor note on cutting from callout (visible to learners) with encouragement to use as a resource.
@ndporter
Copy link
Contributor

ndporter commented Jun 4, 2024

@brownsarahm what do you think of the changes I proposed in response to your suggestion?

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

Typo in "A Note on Cutting"
2 participants