Skip to content

Commit 046ead5

Browse files
authored
docs: fix typos in module documentation (#802)
1 parent e2c497b commit 046ead5

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/pages/tutorials/module.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Inline documentation
44

55
## Inline documentation
66

7-
In this section you will:
7+
In this section, you will:
88

99
- Place some code in a module.
1010
- Provide inline documentation (a "docstring").
@@ -56,15 +56,15 @@ def snell(theta_inc: float, n1: float, n2: float) -> float:
5656
Notice that this example includes inline documentation --- a "docstring". This
5757
is extremely useful for collaborators, and the most common collaborator is
5858
Future You! It also includes type hints; this tells a programmer, type checker,
59-
or IDE what types are expected in an out of the function.
59+
or IDE what types are expected in and out of the function.
6060

6161
Further, by following the [numpydoc standard][], we will be able to
6262
automatically generate nice-looking HTML documentation later. Notable features:
6363

6464
- At the top, there is a succinct, one-line summary of the function's purpose.
65-
It must one line.
65+
It must be one line.
6666

67-
- (Optional) There is an paragraph elaborating on that summary.
67+
- (Optional) There is a paragraph elaborating on that summary.
6868

6969
- There is a section listing input parameters, with the structure
7070

0 commit comments

Comments
 (0)