Skip to content

Commit ebe4ec9

Browse files
committed
🎨 Make a few formatting changes and link corrections
1 parent facc1ee commit ebe4ec9

3 files changed

Lines changed: 51 additions & 32 deletions

File tree

_episodes/17-section1-optional-exercises.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,73 +17,85 @@ Even if you find something that you really like,
1717
we still recommend sticking with the tools that were introduced prior to this episode when you move onto other sections of the course.
1818

1919
> ## Exercise: Apply to your own project(s)
20-
> Apply what you learned in this section to your own project(s).
20+
>
21+
> Apply what you learned in this section to your own project(s).
2122
> This is the time to ask any questions to your instructors or helpers.
2223
> Everyone has different preferences for tooling, so getting the input of experienced developers is a great opportunity.
23-
>
24+
>
2425
{: .challenge}
2526

2627
> ## Exercise: Try out different Integrated Development Environments
28+
>
2729
> Install different Integrated Development Environments (IDEs) and test them out.
2830
> Which one do you like the most and why?
2931
>
30-
> You can try:
32+
> You can try:
33+
>
3134
> - [Visual Studio Code](https://code.visualstudio.com/), with setup instructions [in the Extras of this course]({{ site.baseurl }}{% link _extras/vscode.md %})
3235
> - [Atom](https://atom-editor.cc/)
3336
> - [Sublime Text](https://www.sublimetext.com/)
3437
> - [RStudio](https://posit.co/download/rstudio-desktop/)
35-
>
38+
>
3639
> Technically, compared to PyCharm, the 'IDEs' listed above are source code editors capable of functioning as an IDE
3740
> (with RStudio as an example).
38-
> To function as an IDE, you have to manually install plugins for more powerful features
39-
> such as support for a specific programming language or unit testing.
41+
> To function as an IDE, you have to manually install plugins for more powerful features
42+
> such as support for a specific programming language or unit testing.
4043
> What do you prefer, a lot of tooling out of the box or a lightweight editor with optional extensions?
41-
>
44+
>
4245
> If you want an even more lightweight setup you can try out these configurable source code editors:
46+
>
4347
> - [Emacs](https://www.gnu.org/software/emacs/)
4448
> - [Vim](https://www.vim.org/)
45-
>
49+
>
4650
{: .challenge}
4751

4852
> ## Exercise: Customize the command line
53+
>
4954
> You can customize the command line or use alternatives to `bash` to make yourself more productive.
55+
>
56+
> - Try out [Bash Prompt Generator](https://bash-prompt-generator.org/), it lets you try out different prompts,
57+
> depending on the information you want displayed.
5058
> - Try out [z](https://github.com/rupa/z), a simple tool to more quickly move around directories.
5159
> - Try out [Z shell (zsh)](https://zsh.sourceforge.io/), a shell designed for interactive use.
5260
> - Try out [Oh My ZSH](https://ohmyz.sh/), which is a theming and package manager of the `zsh` terminal.
5361
> - Try out [fish](https://fishshell.com/), a smart and user-friendly command line shell.
54-
> - Try out [Bash Prompt Generator](https://bash-prompt-generator.org/), it lets you try out different prompts,
55-
> depending on the information you want displayed.
56-
>
62+
>
5763
{: .challenge}
5864

5965
> ## Exercise: Try out different virtual environment managers
66+
>
6067
> So far we used `venv`, but there are other virtual environment managers for Python:
61-
> - [Poetry](https://python-poetry.org/).
62-
> - conda, which is part of [Anaconda Distribution)](https://www.anaconda.com/download).
63-
> Anaconda is widely used in academia, but the current license does not allow use for research in most circumstances.
68+
>
69+
> - [Poetry](https://python-poetry.org/), which we will explore using in
70+
> [Section 4]({{ site.baseurl }}{% link _episodes/43-software-release.md %}).
71+
> - conda, which is part of [Anaconda Distribution)](https://www.anaconda.com/download).
72+
>
73+
> Anaconda is widely used in academia, but the current license does not allow use for research in most circumstances.
6474
> An open-source alternative is [mini-forge](https://github.com/conda-forge/miniforge).
65-
>
75+
>
6676
{: .challenge}
6777

6878
> ## Exercise: Customize `pylint`
69-
> You decide to change the max line length of your project to 100 instead of the default 80.
70-
> Find out how you can configure pylint. You can first try to use the pylint command line interface,
79+
>
80+
> You decide to change the max line length of your project to 100 instead of the default 80.
81+
> Find out how you can configure pylint. You can first try to use the pylint command line interface,
7182
> but also play with adding a configuration file that pylint reads in.
7283
>
7384
>> ## Solution
85+
>>
7486
>> ### By passing an argument to `pylint` in the command line
87+
>>
7588
>> Specify the max line length as an argument: `pylint --max-line-length=100`
7689
>>
7790
>> ### Using a configuration file
91+
>>
7892
>> You can create a file `.pylintrc` in the root of your project folder to overwrite pylint settings:
93+
>>
7994
>> ```
8095
>> [FORMAT]
8196
>> max-line-length=100
8297
>> ```
8398
> {: .solution}
8499
{: .challenge}
85100
86-
87-
88-
89101
{% include links.md %}

_episodes/22-scaling-up-unit-testing.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,9 @@ especially in the long term,
351351
and allows others to verify against correct behaviour.
352352
353353
## Optional exercises
354-
Checkout [these optional exercises]({{ site.baseurl }}{% link _episodes/25-section2-optional-exercises.md %}#exercise-customize-pylint)
354+
355+
Checkout
356+
[these optional exercises]({{ site.baseurl }}{% link _episodes/25-section2-optional-exercises.md %})
355357
to learn more about code coverage.
356358
357359
{% include links.md %}
Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Optional exercises for section 2"
2+
title: "Optional Exercises for Section 2"
33
start: false
44
teaching: 0
55
exercises: 45
@@ -10,40 +10,45 @@ objectives:
1010
keypoints:
1111
---
1212

13-
This episode holds some optional exercises for section 2.
13+
This episode holds some optional exercises for section 2.
1414
The exercises have an explorative nature, so feel free to go off in any direction that interests you.
1515
You will be looking at some tools that either complement or are alternatives to those already introduced.
1616
Even if you find something that you really like,
1717
we still recommend sticking with the tools that were introduced prior to this episode when you move onto other sections of the course.
1818

1919
> ## Exercise: Apply to your own project(s)
20-
> Apply what you learned in this section to your own project(s).
21-
> You can think of adding unit tests, add continuous integration pipelines,
20+
>
21+
> Apply what you learned in this section to your own project(s).
22+
> You can think of adding unit tests, add continuous integration pipelines,
2223
> or measure the test coverage of your project(s)
2324
> This is the time to ask any questions to your instructors or helpers.
24-
>
25+
>
2526
{: .challenge}
2627

2728
> ## Exercise: Branch coverage versus line coverage
28-
> For your test coverage, have a look at the concept of
29+
>
30+
> For your test coverage, have a look at the concept of
2931
> [branch coverage](https://about.codecov.io/blog/line-or-branch-coverage-which-type-is-right-for-you/)
30-
> as opposed to just line coverage.
32+
> as opposed to just line coverage.
3133
> Which do you prefer and why?
32-
>
34+
>
3335
{: .challenge}
3436

3537
> ## Exercise: Desirable test coverage
36-
> Look at the projects below and see how much test coverage they have.
38+
>
39+
> Look at the projects below and see how much test coverage they have.
3740
> Should 100% line (or branch) coverage always be the goal? Why or why not?
41+
>
3842
> - [pytest](https://github.com/pytest-dev/pytest)
3943
> - [pyjokes](https://github.com/pyjokes/pyjokes)
4044
> - [scikit-learn](https://github.com/scikit-learn/scikit-learn)
41-
>
45+
>
4246
{: .challenge}
4347

4448
> ## Exercise: Coverage badges
49+
>
4550
> Try to add a [coverage badge](https://github.com/marketplace/actions/coverage-badge) to the inflammation project.
46-
>
51+
>
4752
{: .challenge}
4853

4954
{% include links.md %}

0 commit comments

Comments
 (0)