Skip to content

Commit 79145f1

Browse files
committed
Fix Sphinx typos
1 parent 9ea4837 commit 79145f1

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

episodes/15-coding-conventions.md

Lines changed: 1 addition & 1 deletion
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

slides/section_1_setting_up_environment.md

Lines changed: 1 addition & 1 deletion
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)