-
-
Notifications
You must be signed in to change notification settings - Fork 46
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
Conversation
Mark exercises explicitly in Scripts and Saving episodes; Normalise number of empty lines in/around exercises; Normalise heading level of exercises.
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:
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:
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 |
I just noticed that the explanation of clustering is not yet made into an exercise. |
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
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
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
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:
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.