@@ -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
320320As with other style guide recommendations - consistency is key.
321321Follow 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).
324324Failing 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
362362and this includes a future version of yourself.
363363It can be easy to forget why you did something a particular way in six months' time.
364364Write 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,
400400like 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
403403The reader should be able to understand a single function or method
404404from its code and its comments,
@@ -416,7 +416,7 @@ and comments must be accurate and updated with the code,
416416because 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
719719We have committed our changes locally but
720720have not pushed this branch remotely for others to have a look at our code
721721before 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