aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGravatar Karlis S <[email protected]>2020-03-07 18:26:26 +0200
committerGravatar GitHub <[email protected]>2020-03-07 18:26:26 +0200
commit7bf49843e22757c39a8094dde9381d842d60b8fa (patch)
tree2dbf0aec1733fe1c2841cda575266b98bf41d468 /CONTRIBUTING.md
parent(Space Cog): Added optional search term to `.space nasa` command, removed ran... (diff)
parentMerge pull request #370 from python-discord/feat/deps/355/pep8-naming (diff)
Merge branch 'master' into space-cog
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fd0c048f..ced5df70 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -45,7 +45,7 @@ Seasonalbot utilizes [Pipenv](https://pipenv.readthedocs.io/en/latest/) for inst
When pulling down changes from GitHub, remember to sync your environment using `pipenv sync --dev` to ensure you're using the most up-to-date versions the project's dependencies.
### Type Hinting
-[PEP 484](https://www.python.org/dev/peps/pep-0484/) formally specifies type hints for Python functions, added to the Python Standard Library in version 3.5. Type hints are recognized by most modern code editing tools and provide useful insight into both the input and output types of a function, preventing the user from having to go through the codebase to determine these types.
+[PEP 484](https://www.python.org/dev/peps/pep-0484/) formally specifies type hints for Python functions, added to the Python Standard Library in version 3.5. Type hints are recognized by most modern code editing tools and provide useful insight into both the input and output types of a function, preventing the user from having to go through the codebase to determine these types.
For example:
@@ -86,7 +86,7 @@ def foo(bar: int, baz: dict=None) -> bool:
Does some things with some stuff.
This function takes an index, `bar` and checks for its presence in the database `baz`, passed as a dictionary.
-
+
Returns `False` if `baz` is not passed.
"""
```