Skip to content

Commit

Permalink
Merge pull request #18 from Cambridge-ICCS/fix_typos
Browse files Browse the repository at this point in the history
fixed two typos
  • Loading branch information
MarionBWeinzierl committed Jul 11, 2024
2 parents e3df2d8 + 8017b14 commit b60921f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions slides/_comments_docstrings.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ quotes: `"""..."""`.
Unlike comments, docstrings follow a set format.

Various formatting options exist: numpy, Google, reST, etc.\
We will use numpydoc it is readable and widely used in scientific code.\
We will use numpydoc as it is readable and widely used in scientific code.\
Full guidance for [numpydoc is available](https://numpydoc.readthedocs.io/en/latest/format.html).


Expand Down Expand Up @@ -267,7 +267,7 @@ Go to exercise 5 and examine the comments:
Docstrings:

- Work through the file adding docstrings where they are missing.
- If you are unsure about variable types or meanings at any point you can sneak a look ahead to the code in exercise 5.
- If you are unsure about variable types or meanings at any point you can sneak a look ahead to the code in exercise 6.


## READMEs {.smaller}
Expand Down

0 comments on commit b60921f

Please sign in to comment.