Skip to content

Commit 4fa309e

Browse files
committed
page about "homework" closes #44, closes #46
1 parent 14ab3df commit 4fa309e

File tree

3 files changed

+37
-6
lines changed

3 files changed

+37
-6
lines changed

content/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Image to get started:
1616
questions
1717
learning-outcomes
1818
lesson
19+
optional-homework
1920
encapsulation
2021
:::
2122

content/lesson.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,3 @@ the ideas and steps in the {ref}`guide`.
7070
It is OK and good if mistakes happen and it is fun if the instructor(s) can
7171
convey a bit of "improv" feel to this lesson.
7272
:::
73-
74-
75-
## Additional exercises
76-
77-
Draw a call tree for one of your recent projects. Identify the
78-
functions in your call tree which are "pure" (which have no side-effects).

content/optional-homework.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Optional home-/group work
2+
3+
:::{admonition} This is completely optional
4+
You can participate in the lesson without working on any of the tasks below.
5+
6+
We share these for individuals and groups who would like to work on some of
7+
these in preparation of the lesson or independently of a CodeRefinery workshop
8+
with their study group.
9+
10+
We might comment on the contributed solutions during the lesson
11+
but we will definitely do so in a constructive and positive way.
12+
:::
13+
14+
You can practice on our [exercise repository](https://github.com/coderefinery/modular-type-along-exercise) which contains:
15+
- Data set
16+
- Python notebook which works but is not super general
17+
18+
How to contribute improvements:
19+
- Open issue at the [exercise repository](https://github.com/coderefinery/modular-type-along-exercise) and in your pull request refer to that issue.
20+
21+
Exercise ideas (sorted from basic to advanced):
22+
- Improve the README
23+
- Add example usage to the README
24+
- Add a result image to the README
25+
- Make it installable and document installation (requirements.txt or environment.yml, pip/conda/...)
26+
- Add a command line interface
27+
- Improve error messages (e.g. input file does not exist or does not contain data we want to plot)
28+
- Draw a call tree for one of your recent projects. Identify the
29+
functions in your call tree which are "pure" (which have no side-effects).
30+
- Add more automated tests
31+
- Try some of the strategies in this lesson on your own data
32+
- Contribute a notebook/script with weather data from your place **in your
33+
favorite programming language**
34+
- If you use AI, any tricks you can share to get modular code from it?
35+
- Make the notebook (more) reproducible
36+
- Add support for Snakemake or any other workflow management tool

0 commit comments

Comments
 (0)