Skip to content

Commit 8fcaee8

Browse files
authored
Merge pull request #424 from carpentries-incubator/optinal-exercises
Small wording fixes to optional exercises
2 parents 967d255 + dd6e8ae commit 8fcaee8

File tree

2 files changed

+30
-33
lines changed

2 files changed

+30
-33
lines changed

episodes/12-virtual-environments.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -649,13 +649,9 @@ It looks like the script expects a list of input files to process,
649649
so this is expected behaviour since we do not supply any.
650650
We will fix this error in a moment.
651651

652-
## Optional exercises
653-
654-
Checkout [this optional exercise](17-section1-optional-exercises.md)
655-
to try out different virtual environment managers.
656-
Or, [this exercise](17-section1-optional-exercises.md)
657-
to customize the command line.
652+
## Optional Exercises
658653

654+
Have a look at [some optional exercises](17-section1-optional-exercises.md).
659655

660656

661657
:::::::::::::::::::::::::::::::::::::::: keypoints

episodes/17-section1-optional-exercises.md

+28-27
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 1.7 Optional Exercises for Section 1
2+
title: 1.7 Optional Exercises
33
start: no
44
teaching: 0
55
exercises: 45
@@ -13,23 +13,25 @@ exercises: 45
1313

1414
:::::::::::::::::::::::::::::::::::::::: questions
1515

16-
- How can I further finetune my coding environment?
16+
- How can I further fine-tune my coding environment?
1717

1818
::::::::::::::::::::::::::::::::::::::::::::::::::
1919

20-
This episode holds some optional exercises for section 1.
20+
This episode has some optional exercises for Section 1.
2121
The exercises have an explorative nature, so feel free to go off in any direction that interests you.
2222
You will be looking at some tools that either complement or are alternatives to those already introduced.
2323
Even if you find something that you really like,
24-
we still recommend sticking with the tools that were introduced prior to this episode when you move onto other sections of the course.
24+
for the sake of following through with the course, we still recommend sticking with the tools that we introduced prior to this episode
25+
and then switching to something else afterwards.
2526

26-
::::::::::::::::::::::::::::::::::::::: challenge
27+
::::::::::::::::::::::::::::::::::::::: discussion
2728

2829
## Exercise: Apply to your own project(s)
2930

3031
Apply what you learned in this section to your own project(s).
31-
This is the time to ask any questions to your instructors or helpers.
32-
Everyone has different preferences for tooling, so getting the input of experienced developers is a great opportunity.
32+
This is the time to ask any questions of your instructors, helpers or fellow learners.
33+
Everyone has different preferences for tooling, so getting input from experienced developers is a great opportunity to learn new things
34+
or different perspectives.
3335

3436
::::::::::::::::::::::::::::::::::::::::::::::::::
3537

@@ -40,17 +42,17 @@ Everyone has different preferences for tooling, so getting the input of experien
4042
Install different Integrated Development Environments (IDEs) and test them out.
4143
Which one do you like the most and why?
4244

43-
You can try:
45+
Some suggestions to try:
4446

4547
- [Visual Studio Code](https://code.visualstudio.com/), with setup instructions [in the Extras of this course](../learners/vscode.md)
4648
- [Atom](https://atom-editor.cc/)
4749
- [Sublime Text](https://www.sublimetext.com/)
4850
- [RStudio](https://posit.co/download/rstudio-desktop/)
4951

50-
Technically, compared to PyCharm, the 'IDEs' listed above are source code editors capable of functioning as an IDE
51-
(with RStudio as an example).
52-
To function as an IDE, you have to manually install plugins for more powerful features
52+
When compared to PyCharm, the IDEs listed above are advanced source code editors capable of functioning as IDEs.
53+
To function as an IDE, you have to manually install plugins for these tools to obtain more advanced features -
5354
such as support for a specific programming language or unit testing.
55+
5456
What do you prefer, a lot of tooling out of the box or a lightweight editor with optional extensions?
5557

5658
If you want an even more lightweight setup you can try out these configurable source code editors:
@@ -62,28 +64,27 @@ If you want an even more lightweight setup you can try out these configurable so
6264

6365
::::::::::::::::::::::::::::::::::::::: challenge
6466

65-
## Exercise: Customize the command line
67+
## Exercise: Customise the command line tool
6668

67-
You can customize the command line or use alternatives to `bash` to make yourself more productive.
69+
You can customise the command line tool or use alternatives to `bash`, such as:
6870

69-
- Try out [Bash Prompt Generator](https://bash-prompt-generator.org/), it lets you try out different prompts,
71+
- [Bash Prompt Generator](https://bash-prompt-generator.org/) - it lets you try out different prompts,
7072
depending on the information you want displayed.
71-
- Try out [z, a simple tool to more quickly move around directories](https://github.com/rupa/z).
72-
- Try out [Z shell (zsh)](https://zsh.sourceforge.io/), a shell designed for interactive use.
73-
- Try out [Oh My ZSH](https://ohmyz.sh/), which is a theming and package manager of the `zsh` terminal.
74-
- Try out [fish](https://fishshell.com/), a smart and user-friendly command line shell.
73+
- [z, a simple tool to more quickly move around directories](https://github.com/rupa/z).
74+
- [Z shell (zsh)](https://zsh.sourceforge.io/), a shell designed for interactive use.
75+
- [Oh My ZSH](https://ohmyz.sh/), which is a theming and package manager of the `zsh` terminal.
76+
- [fish](https://fishshell.com/), a smart and user-friendly command line shell.
7577

7678
::::::::::::::::::::::::::::::::::::::::::::::::::
7779

7880
::::::::::::::::::::::::::::::::::::::: challenge
7981

8082
## Exercise: Try out different virtual environment managers
8183

82-
So far we used `venv`, but there are other virtual environment managers for Python:
84+
So far we have used `venv`, but there are other virtual environment managers for Python:
8385

84-
- [Poetry](https://python-poetry.org/), which we will explore using in
85-
[Section 4](43-software-release.md).
86-
- conda, which is part of [Anaconda Distribution)](https://www.anaconda.com/download).
86+
- [Poetry](https://python-poetry.org/), which we will explore using in [Section 4](43-software-release.md).
87+
- `conda`, which is part of [Anaconda Distribution](https://www.anaconda.com/download).
8788

8889
Anaconda is widely used in academia, but the current license does not allow use for research in most circumstances.
8990
An open-source alternative is [mini-forge](https://github.com/conda-forge/miniforge).
@@ -92,11 +93,11 @@ An open-source alternative is [mini-forge](https://github.com/conda-forge/minifo
9293

9394
::::::::::::::::::::::::::::::::::::::: challenge
9495

95-
## Exercise: Customize `pylint`
96+
## Exercise: Customise `pylint`
97+
98+
Tell `pylint` to accept the maximum line length of 100 characters instead of the default 80.
9699

97-
You decide to change the max line length of your project to 100 instead of the default 80.
98-
Find out how you can configure pylint. You can first try to use the pylint command line interface,
99-
but also play with adding a configuration file that pylint reads in.
100+
Hint: find out different ways in which you can configure `pylint` (e.g. via `pylint` command line interface or its configuration file).
100101

101102
::::::::::::::: solution
102103

@@ -108,7 +109,7 @@ Specify the max line length as an argument: `pylint --max-line-length=100`
108109

109110
### Using a configuration file
110111

111-
You can create a file `.pylintrc` in the root of your project folder to overwrite pylint settings:
112+
You can create a file `.pylintrc` in the root of your project folder to overwrite `pylint` settings:
112113

113114
```
114115
[FORMAT]

0 commit comments

Comments
 (0)