aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar wookie184 <[email protected]>2022-03-31 18:47:56 +0100
committerGravatar GitHub <[email protected]>2022-03-31 18:47:56 +0100
commitd6b0b6c86578d374ba7247dd30fc030851b27cbc (patch)
treed644574e2cb4f63f83aac7acb7dd631d1967e072
parentImplement suggestions (diff)
Update type-hint.md
-rw-r--r--bot/resources/tags/type-hint.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/bot/resources/tags/type-hint.md b/bot/resources/tags/type-hint.md
index 17b57aff3..122a12fcf 100644
--- a/bot/resources/tags/type-hint.md
+++ b/bot/resources/tags/type-hint.md
@@ -1,19 +1,19 @@
**Type Hints**
-A type hint indicates what type something is expected to be. For example,
+A type hint indicates what type a variable is expected to be.
```python
def add(a: int, b: int) -> int:
return a + b
```
-In this case, we have a function,`add`, with parameters `a` and `b`. The type hints indicate that the parameters and return type are all integers.
+The type hints indicate that for our `add` function the parameters `a` and `b` should be integers, and the function should return an integer when called.
+
+It's important to note these are just hints and are not enforced at runtime.
-It's important to note these are just hints and have no runtime effect. For example,
```python
-# Uh oh
add("hello ", "world")
```
-This code won't error even though it doesn't follow the function's type hints. It will just concatenate the two strings.
+The above code won't error even though it doesn't follow the function's type hints; the two strings will be concatenated as normal.
-Third party tools like [mypy](http://mypy-lang.org/) can enforce your type hints. Mypy would error in the second example.
+Third party tools like [mypy](https://mypy.readthedocs.io/en/stable/introduction.html) can validate your code to ensure it is type hinted correctly. This can help you identify potentially buggy code, for example it would error on the second example as our `add` function is not intended to concatenate strings.
-For more info about type hints, check out [PEP 484](https://www.python.org/dev/peps/pep-0484/).
+[`mypy`s documentation](https://mypy.readthedocs.io/en/stable/builtin_types.html) contains useful information on type hinting, and for more information check out [this documentation page](https://typing.readthedocs.io/en/latest/index.html).