Skip to content

Commit

Permalink
Use correct function name in documentation (#142)
Browse files Browse the repository at this point in the history
It should be check_return_type(), but the example used check_return_value().
  • Loading branch information
wbolster committed Aug 14, 2020
1 parent 9673ad1 commit 01a6fc4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/userguide.rst
Expand Up @@ -15,12 +15,12 @@ and the return value does not match the return type annotation, then a :exc:`Typ

For example::

from typeguard import check_argument_types, check_return_value
from typeguard import check_argument_types, check_return_type

def some_function(a: int, b: float, c: str, *args: str) -> bool:
assert check_argument_types()
...
assert check_return_value(retval)
assert check_return_type(retval)
return retval

When combined with the ``assert`` statement, these checks are automatically removed from the code
Expand Down

0 comments on commit 01a6fc4

Please sign in to comment.