Skip to content

Commit db5b7c8

Browse files
remove ABV isn't and others
1 parent 52e7e7e commit db5b7c8

42 files changed

Lines changed: 452 additions & 451 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ label ![pilot](https://shields.io/badge/-pilot-31E930).
5656
We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any
5757
questions, concerns, or experience any difficulties along the way.
5858

59-
We'd like to ask you to familiarise yourself with our [Contribution Guide](CONTRIBUTING.md) and have a look at
59+
We would like to ask you to familiarise yourself with our [Contribution Guide](CONTRIBUTING.md) and have a look at
6060
the [more detailed guidelines][lesson-example] on proper formatting, instructions on compiling and rendering the lesson locally, and
6161
making any changes and adding new content or episodes.
6262

_episodes/00-setting-the-scene.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ So, you have gained basic software development skills either by self-learning or
2525
e.g., a [novice Software Carpentry course][swc-lessons].
2626
You have been applying those skills for a while by writing code to help with your work
2727
and you feel comfortable developing code and troubleshooting problems.
28-
However, your software has now reached a point where there’s too much code to be kept in one script.
29-
Perhaps it's involving more researchers (developers) and users,
28+
However, your software has now reached a point where there is too much code to be kept in one script.
29+
Perhaps it is involving more researchers (developers) and users,
3030
and more collaborative development effort is needed to add new functionality
3131
while ensuring previous development efforts remain functional and maintainable.
3232

_episodes/10-section1-intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and introducing the project that we will be working on throughout the course.
2020
In order to build working (research) software efficiently
2121
and to do it in collaboration with others rather than in isolation,
2222
you will have to get comfortable with using a number of different tools interchangeably
23-
as they’ll make your life a lot easier.
23+
as they will make your life a lot easier.
2424
There are many options when it comes to deciding
2525
which software development tools to use for your daily tasks -
2626
we will use a few of them in this course that we believe make a difference.
@@ -124,6 +124,6 @@ Therefore, one should be aware of these guidelines
124124
and adhere to whatever the project you are working on has specified.
125125
In Python, we will be looking at a convention called PEP8.
126126

127-
Let's get started with setting up our software development environment!
127+
Let us get started with setting up our software development environment!
128128

129129
{% include links.md %}

_episodes/11-software-project.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ A novice will often make up the structure of their code as they go along.
246246
However, for more advanced software development,
247247
we need to plan and design this structure - called a *software architecture* - beforehand.
248248
249-
Let's have a quick look into what a software architecture is
249+
Let us have a quick look into what a software architecture is
250250
and which architecture is used by our software project
251251
before we start adding more code to it.
252252

_episodes/12-virtual-environments.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ the `requirements.txt` file."
2525
## Introduction
2626
So far we have cloned our software project from GitHub and inspected its contents and architecture a bit.
2727
We now want to run our code to see what it does -
28-
let's do that from the command line.
28+
let us do that from the command line.
2929
For the most part of the course we will run our code
3030
and interact with Git from the command line.
3131
While we will develop and debug our code using the PyCharm IDE
@@ -236,7 +236,7 @@ This will create the target directory for the virtual environment
236236
> and avoid issues that could prove difficult to trace and debug.
237237
{: .callout}
238238
239-
For our project let's create a virtual environment called "venv".
239+
For our project let us create a virtual environment called "venv".
240240
First, ensure you are within the project root directory, then:
241241
242242
~~~
@@ -342,7 +342,7 @@ When you’re done working on your project, you can exit the environment with:
342342
~~~
343343
{: .language-bash}
344344
345-
If you've just done the `deactivate`,
345+
If you have just done the `deactivate`,
346346
ensure you reactivate the environment ready for the next part:
347347
348348
~~~
@@ -565,7 +565,7 @@ In the above command, we tell the command line two things:
565565
As we can see, the Python interpreter ran our script, which threw an error -
566566
`inflammation-analysis.py: error: the following arguments are required: infiles`.
567567
It looks like the script expects a list of input files to process,
568-
so this is expected behaviour since we don't supply any.
568+
so this is expected behaviour since we do not supply any.
569569
We will fix this error in a moment.
570570
571571
## Optional exercises

_episodes/13-ides.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@ and Microsoft's free [Visual Studio Code (VS Code)](https://code.visualstudio.co
8080

8181
## Using the PyCharm IDE
8282

83-
Let's open our project in PyCharm now and familiarise ourselves with some commonly used features.
83+
Let us open our project in PyCharm now and familiarise ourselves with some commonly used features.
8484

8585
### Opening a Software Project
86-
If you don't have PyCharm running yet, start it up now.
86+
If you do not have PyCharm running yet, start it up now.
8787
You can skip the initial configuration steps which just go through
8888
selecting a theme and other aspects.
8989
You should be presented with a dialog box that asks you what you want to do,
@@ -156,7 +156,7 @@ and PyCharm is clever enough to understand it.
156156
so we can also use this environment for other projects if we wish.
157157
6. Select `OK` in the `Add Python Interpreter` window.
158158
Back in the `Preferences` window, you should select "Python 3.11 (python-intermediate-inflammation)"
159-
or similar (that you've just added) from the `Project Interpreter` drop-down list.
159+
or similar (that you have just added) from the `Project Interpreter` drop-down list.
160160

161161
Note that a number of external libraries have magically appeared under the
162162
"Python 3.11 (python-intermediate-inflammation)" interpreter,
@@ -170,7 +170,7 @@ and has added these libraries effectively replicating our virtual environment in
170170
Also note that, although the names are not the same -
171171
this is one and the same virtual environment
172172
and changes done to it in PyCharm will propagate to the command line and vice versa.
173-
Let's see this in action through the following exercise.
173+
Let us see this in action through the following exercise.
174174

175175
> ## Exercise: Compare External Libraries in the Command Line and PyCharm
176176
> Can you recall two places where information about our project's dependencies
@@ -314,15 +314,15 @@ You can also verify this from the command line by
314314
listing the `venv/lib/python3.11/site-packages` subdirectory.
315315
Note, however, that `requirements.txt` is not updated -
316316
as we mentioned earlier this is something you have to do manually.
317-
Let's do this as an exercise.
317+
Let us do this as an exercise.
318318
319319
> ## Exercise: Update `requirements.txt` After Adding a New Dependency
320320
> Export the newly updated virtual environment into `requirements.txt` file.
321321
>
322322
>
323323
>> ## Solution
324-
>> Let's verify first that the newly installed library `pytest` is appearing in our virtual environment
325-
>> but not in `requirements.txt`. First, let's check the list of installed packages:
324+
>> Let us verify first that the newly installed library `pytest` is appearing in our virtual environment
325+
>> but not in `requirements.txt`. First, let us check the list of installed packages:
326326
>> ~~~
327327
>> (venv) $ python3 -m pip list
328328
>> ~~~
@@ -412,7 +412,7 @@ and use on top of virtual environments.
412412
(i.e. the virtual environment and interpreter you configured earlier in this episode)
413413
in the `Python interpreter` field.
414414
5. You can give this run configuration a name at the top of the window if you like -
415-
e.g. let's name it `inflammation analysis`.
415+
e.g. let us name it `inflammation analysis`.
416416
6. You can optionally configure run parameters and environment variables in the same window -
417417
we do not need this at the moment.
418418
7. Select `Apply` to confirm these settings.
@@ -438,15 +438,15 @@ and use on top of virtual environments.
438438
Now you know how to configure and manipulate your environment in both tools
439439
(command line and PyCharm),
440440
which is a useful parallel to be aware of.
441-
Let's have a look at some other features afforded to us by PyCharm.
441+
Let us have a look at some other features afforded to us by PyCharm.
442442
443443
### Syntax Highlighting
444444
The first thing you may notice is that code is displayed using different colours.
445445
Syntax highlighting is a feature that displays source code terms
446446
in different colours and fonts according to the syntax category the highlighted term belongs to.
447447
It also makes syntax errors visually distinct.
448448
Highlighting does not affect the meaning of the code itself -
449-
it's intended only for humans to make reading code and finding errors easier.
449+
it is intended only for humans to make reading code and finding errors easier.
450450
451451
![Syntax Highlighting Functionality in PyCharm](../fig/pycharm-syntax-highlighting.png){: .image-with-shadow width="1000px" }
452452
@@ -569,7 +569,7 @@ We will get back to this error shortly -
569569
for now, the good thing is that we managed to set up our project for development
570570
both from the command line and PyCharm and are getting the same outputs.
571571
Before we move on to fixing errors and writing more code,
572-
let's have a look at the last set of tools for collaborative code development
572+
Let us have a look at the last set of tools for collaborative code development
573573
which we will be using in this course - Git and GitHub.
574574
575575

_episodes/14-collaboration-using-git.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ test it to make sure it works correctly and as expected,
3636
then record your changes using version control
3737
and share your work with others via a shared and centrally backed-up repository.
3838

39-
Firstly, let's remind ourselves how to work with Git from the command line.
39+
Firstly, let us remind ourselves how to work with Git from the command line.
4040

4141
## Git Refresher
4242
Git is a version control system for tracking changes in computer files
@@ -117,7 +117,7 @@ Software development lifecycle with Git
117117
</p>
118118

119119
## Checking-in Changes to Our Project
120-
Let's check-in the changes we have done to our project so far.
120+
Let us check-in the changes we have done to our project so far.
121121
The first thing to do upon navigating into our software project's directory root
122122
is to check the current status of our local working directory and repository.
123123

@@ -162,7 +162,7 @@ and stop notifying us about it.
162162
Edit your `.gitignore` file in PyCharm
163163
and add a line containing "venv/" and another one containing ".venv/".
164164
It does not matter much in this case where within the file you add these lines,
165-
so let's do it at the end.
165+
so let us do it at the end.
166166
Your `.gitignore` should look something like this:
167167

168168
~~~
@@ -256,7 +256,7 @@ $ git pull
256256
~~~
257257
{: .language-bash}
258258

259-
Now we've ensured our repository is synchronised with the remote one,
259+
Now we have ensured our repository is synchronised with the remote one,
260260
we can now push our changes:
261261

262262
~~~
@@ -324,11 +324,11 @@ $ git branch
324324
~~~
325325
{: .output}
326326
327-
At the moment, there's only one branch (`main`)
327+
At the moment, there is only one branch (`main`)
328328
and hence only one version of the code available.
329329
When you create a Git repository for the first time,
330330
by default you only get one version (i.e. branch) - `main`.
331-
Let's have a look at why having different branches might be useful.
331+
Let us have a look at why having different branches might be useful.
332332
333333
### Feature Branch Software Development Workflow
334334
While it is technically OK to commit your changes directly to `main` branch,
@@ -341,7 +341,7 @@ Each feature branch should have its own meaningful name -
341341
indicating its purpose (e.g. "issue23-fix").
342342
If we keep making changes and pushing them directly to `main` branch on GitHub,
343343
then anyone who downloads our software from there will get all of our work in progress -
344-
whether or not it's ready to use!
344+
whether or not it is ready to use!
345345
So, working on a separate branch for each feature you are adding is good for several reasons:
346346
347347
* it enables the main branch to remain stable
@@ -382,7 +382,7 @@ Whichever is the case for you, a good rule of thumb is -
382382
nothing that is broken should be in `main`.
383383
384384
### Creating Branches
385-
Let's create a `develop` branch to work on:
385+
Let us create a `develop` branch to work on:
386386
387387
~~~
388388
$ git branch develop
@@ -435,7 +435,7 @@ the commits will happen on the `develop` branch
435435
and will not affect the version of the code in `main`.
436436
We add and commit things to `develop` branch in the same way as we do to `main`.
437437
438-
Let's make a small modification to `inflammation/models.py` in PyCharm,
438+
Let us make a small modification to `inflammation/models.py` in PyCharm,
439439
and, say, change the spelling of "2d" to "2D" in docstrings for functions
440440
`daily_mean()`,
441441
`daily_max()` and
@@ -505,7 +505,7 @@ $ git push -u origin develop
505505
> We still prefer to explicitly state this information in commands.
506506
{: .callout}
507507
508-
Let's confirm that the new branch `develop` now exist remotely on GitHub too.
508+
Let us confirm that the new branch `develop` now exist remotely on GitHub too.
509509
From the `Code` tab in your repository in GitHub,
510510
click the branch dropdown menu (currently showing the default branch `main`).
511511
You should see your `develop` branch in the list too.
@@ -526,7 +526,7 @@ $ git push origin develop
526526
{: .language-bash}
527527
528528
> ## What is the Relationship Between Originating and New Branches?
529-
> It's natural to think that new branches have a parent/child relationship
529+
> it is natural to think that new branches have a parent/child relationship
530530
> with their originating branch,
531531
> but in actual Git terms, branches themselves do not have parents
532532
> but single commits do.

_episodes/15-coding-conventions.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ a description of a new feature in Python, etc.
6565
> However, know when to be inconsistent -
6666
> sometimes style guide recommendations are just not applicable.
6767
> When in doubt, use your best judgment.
68-
> Look at other examples and decide what looks best. And don't hesitate to ask!
68+
> Look at other examples and decide what looks best. And do not hesitate to ask!
6969
>
7070
{: .callout}
7171

@@ -279,7 +279,7 @@ Avoid extraneous whitespace in the following situations:
279279
augmented assignment (+=, -= etc.),
280280
comparisons (==, <, >, !=, <>, <=, >=, in, not in, is, is not),
281281
booleans (and, or, not).
282-
- Don't use spaces around the = sign
282+
- do not use spaces around the = sign
283283
when used to indicate a keyword argument assignment
284284
or to indicate a default value for an unannotated function parameter
285285
~~~
@@ -319,7 +319,7 @@ e.g HTTPServerError)
319319
320320
As with other style guide recommendations - consistency is key.
321321
Follow the one already established in the project, if there is one.
322-
If there isn't, follow any standard language style (such as
322+
If there is not, follow any standard language style (such as
323323
[PEP 8](https://www.python.org/dev/peps/pep-0008/) for Python).
324324
Failing that, just pick one, document it and stick to it.
325325
@@ -362,7 +362,7 @@ A good rule of thumb is to assume that someone will *always* read your code at a
362362
and this includes a future version of yourself.
363363
It can be easy to forget why you did something a particular way in six months' time.
364364
Write comments as complete sentences and in English
365-
unless you are 100% sure the code will never be read by people who don't speak your language.
365+
unless you are 100% sure the code will never be read by people who do not speak your language.
366366
367367
> ## The Good, the Bad, and the Ugly Comments
368368
> As a side reading, check out the
@@ -396,9 +396,9 @@ def fahr_to_cels(fahr):
396396
~~~
397397
{: .language-python}
398398
399-
Python doesn't have any multi-line comments,
399+
Python does not have any multi-line comments,
400400
like you may have seen in other languages like C++ or Java.
401-
However, there are ways to do it using *docstrings* as we'll see in a moment.
401+
However, there are ways to do it using *docstrings* as we will see in a moment.
402402
403403
The reader should be able to understand a single function or method
404404
from its code and its comments,
@@ -416,7 +416,7 @@ and comments must be accurate and updated with the code,
416416
because an incorrect comment causes more confusion than no comment at all.
417417
418418
> ## Exercise: Improve Code Style of Our Project
419-
> Let's look at improving the coding style of our project.
419+
> let us look at improving the coding style of our project.
420420
> First, from the project root, use `git switch` to create a new feature branch called `style-fixes`
421421
> from our develop branch.
422422
> (Note that at this point `develop` and `main` branches
@@ -494,7 +494,7 @@ because an incorrect comment causes more confusion than no comment at all.
494494
>> (and class) definitions with two blank lines).
495495
>> Note how PyCharm is warning us by underlining the whole line below.
496496
>>
497-
>> Finally, let's add and commit our changes to the feature branch.
497+
>> Finally, let us add and commit our changes to the feature branch.
498498
>> We will check the status of our working directory first.
499499
>>
500500
>> ~~~
@@ -515,7 +515,7 @@ because an incorrect comment causes more confusion than no comment at all.
515515
>>
516516
>> Git tells us we are on branch `style-fixes`
517517
>> and that we have unstaged and uncommited changes to `inflammation-analysis.py`.
518-
>> Let's commit them to the local repository.
518+
>> let us commit them to the local repository.
519519
>>
520520
>> ~~~
521521
>> $ git add inflammation-analysis.py
@@ -706,7 +706,7 @@ help(fibonacci)
706706
> >
707707
> > As expected, Git tells us we are on branch `style-fixes`
708708
> > and that we have unstaged and uncommited changes to `inflammation/models.py`.
709-
> > Let's commit them to the local repository.
709+
> > Let us commit them to the local repository.
710710
> > ~~~
711711
> > $ git add inflammation/models.py
712712
> > $ git commit -m "Docstring improvements."
@@ -719,7 +719,7 @@ In the previous exercises, we made some code improvements on feature branch `sty
719719
We have committed our changes locally but
720720
have not pushed this branch remotely for others to have a look at our code
721721
before we merge it onto the `develop` branch.
722-
Let's do that now, namely:
722+
Let us do that now, namely:
723723
724724
- push `style-fixes` to GitHub
725725
- merge `style-fixes` into `develop` (once we are happy with the changes)
@@ -742,7 +742,7 @@ $ git push origin main
742742
{: .language-bash}
743743
744744
> ## Typical Code Development Cycle
745-
> What you've done in the exercises in this episode mimics a typical software development workflow -
745+
> What you have done in the exercises in this episode mimics a typical software development workflow -
746746
> you work locally on code on a feature branch,
747747
> test it to make sure it works correctly and as expected,
748748
> then record your changes using version control

0 commit comments

Comments
 (0)