Skip to content
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

add details about type hinting to authoring guide #4941

Merged
merged 3 commits into from
Nov 4, 2020
Merged

add details about type hinting to authoring guide #4941

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6a41ff
add details about type hinting to authoring guide
leahecole Nov 4, 2020
58f84bb
Update AUTHORING_GUIDE.md
leahecole Nov 4, 2020
6f6c033
Merge branch 'master' into type-hint
leahecole Nov 4, 2020
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
9 changes: 8 additions & 1 deletion AUTHORING_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,17 @@ Argument types should be documented using Python type annotations as
introduced in [PEP 484](https://www.python.org/dev/peps/pep-0484/). For example:

```py
def hello_world(name: string):
def hello_world(name: str) -> None:
print(f"Hello {name}!")
```

```py
def adder(a: int, b: int) -> int:
return a+b
```

Type hinting is enforced using [`flake8-annotations`](https://pypi.org/project/flake8-annotations/), which is enabled by setting the `enforce_type_hints` variable to `True` in the appropriate `noxfile_config.py`. Type hinting is expected in all new samples, and will gradually be added to all compatible existing samples.

If there is an `Args` section within the function's docstring, consider
documenting the argument types there as well. For example:

Expand Down