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

Format exercises, add descriptive titles #159

Merged
merged 2 commits into from
Jun 12, 2023

Conversation

bencomp
Copy link
Contributor

@bencomp bencomp commented May 30, 2023

This fixes #157 and fixes #121.

Regarding the titles of exercises: I feel I could use a style guideline here, as this first attempt has inconsistent forms of verbs, or no verbs at all in the title. What form is preferred? Some examples:

  • "Remove a trailing space"
  • "Commonly owned items"
  • "Finding (potential) errors"

To fix #121 I wrapped the mentioned steps in a challenge fenced div. I did the same for some other "exercise-like walk-throughs". But now in some places there isn't much explanation left. This causes new issues like #158.

bencomp added 2 commits May 30, 2023 16:55
Mark exercises explicitly in Scripts and Saving episodes;
Normalise number of empty lines in/around exercises;
Normalise heading level of exercises.
@bencomp bencomp requested a review from a team May 30, 2023 17:06
@github-actions
Copy link

github-actions bot commented May 30, 2023

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/datacarpentry/openrefine-socialsci/compare/md-outputs..md-outputs-PR-159

The following changes were observed in the rendered markdown documents:

 02-working-with-openrefine.md | 36 +++++++++++++++++++++++-------------
 03-filter-sort.md             | 34 +++++++++++++++-------------------
 04-numbers.md                 |  9 +++------
 05-scripts.md                 | 13 +++++++++++--
 06-saving.md                  |  6 +++++-
 07-resources.md               |  4 +---
 md5sum.txt                    | 12 ++++++------
 7 files changed, 64 insertions(+), 50 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 2023-05-30 17:07:49 +0000

github-actions bot pushed a commit that referenced this pull request May 30, 2023
@bencomp
Copy link
Contributor Author

bencomp commented Jun 9, 2023

I just noticed that the explanation of clustering is not yet made into an exercise.

@bencomp bencomp merged commit afc2167 into datacarpentry:main Jun 12, 2023
github-actions bot pushed a commit that referenced this pull request Jun 12, 2023
Auto-generated via {sandpaper}
Source  : afc2167
Branch  : main
Author  : Ben Companjen <[email protected]>
Time    : 2023-06-12 20:11:05 +0000
Message : Merge pull request #159 from bencomp/157-exercise-titles

Format exercises, add descriptive titles
github-actions bot pushed a commit that referenced this pull request Jun 12, 2023
Auto-generated via {sandpaper}
Source  : 9ec0569
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-06-12 20:12:26 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : afc2167
Branch  : main
Author  : Ben Companjen <[email protected]>
Time    : 2023-06-12 20:11:05 +0000
Message : Merge pull request #159 from bencomp/157-exercise-titles

Format exercises, add descriptive titles
github-actions bot pushed a commit that referenced this pull request Jun 13, 2023
Auto-generated via {sandpaper}
Source  : 9ec0569
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2023-06-12 20:12:26 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : afc2167
Branch  : main
Author  : Ben Companjen <[email protected]>
Time    : 2023-06-12 20:11:05 +0000
Message : Merge pull request #159 from bencomp/157-exercise-titles

Format exercises, add descriptive titles
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.

Set descriptive titles for exercises Script episode indicates time for exercise, but there is no exercise
2 participants