Skip to content

Fix typos in module documentation #802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Niel-77 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

Fix typos in module documentation #802

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/pages/tutorials/module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Inline documentation

## Inline documentation

In this section you will:
In this section, you will:

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

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

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

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

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

Expand Down
Loading