Skip to content

Commit 967d255

Browse files
authored
Merge pull request #438 from tomneep/sphinx-typo
Fix Sphinx typos and typo in 21-automatically-testing-software
2 parents 41b70ec + 911e954 commit 967d255

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

episodes/15-coding-conventions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@ or using triple quotes as a way to 'quickly' comment out an entire block of code
608608
is considered bad practice.
609609

610610
In our example case, we used the
611-
[Sphynx/ReadTheDocs docstring style](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html)
611+
[Sphinx/ReadTheDocs docstring style](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html)
612612
formatting for the `param`, `raises` and `returns` - other docstring formats exist as well.
613613

614614
::::::::::::::::::::::::::::::::::::::::: callout

episodes/21-automatically-testing-software.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ There are three main types of automated tests:
9090
for example after making changes your code to add new functionality or fix a bug.
9191

9292
For the purposes of this course, we will focus on unit tests.
93-
But the principles and practices we wll talk about can be built on
93+
But the principles and practices we will talk about can be built on
9494
and applied to the other types of tests too.
9595

9696
## Set Up a New Feature Branch for Writing Tests

slides/section_1_setting_up_environment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ Start from this section heading and go to the end of the page.
547547
- A lot of these checks for formatting can now be done automatically with your IDE or linters, so do not spend too long absorbing them. It is good to be aware why rules are being applied, but the details of implementation are less important.
548548
- poll/status check at the end
549549
- Some comments after the exercises
550-
- There are many different docstring formats, and I tend to not like the Sphynx default very much. Google or Numpy style docstrings much more readable.
550+
- There are many different docstring formats, and I tend to not like the Sphinx default very much. Google or Numpy style docstrings much more readable.
551551
- For the exercise to improve the docstrings, no mention is made of the fact that the module docstring should include a list of the functions in the module. This is another valid improvement. (Advance to next slide to see this)
552552
<!-- #endregion -->
553553

0 commit comments

Comments
 (0)