Closed
Description
Expected Behavior
When generating doc for a package that is annotated with PEP 484 type hints, I would expect the type hints to be present in the documentation.
For example, the following definition
def foo(x: Bar, repeat : int = 1):
"""Foo-cate a Bar a number of times (default: 1)."""
...results in the type hints being available in the REPL's help():
>>> help(foo)
foo(x: __main__.Bar, repeat: int = 1)
Foo-cate a Bar a number of times (default: 1).and it should well as be present in the pdoc-generated documents:
$ pdoc example.py
Module example
==============
Functions
---------
`foo(x: Bar, repeat: int = 1)`
: Foo-cate a Bar a number of times (default: 1).
Classes
-------
`Bar`Actual Behavior
pdoc ignores the type-hints:
$ pdoc example.py
Module example
==============
Functions
---------
`foo(x, repeat=1)`
: Foo-cate a Bar a number of times (default: 1).
Classes
-------
`Bar`Type hints document the expected types of parameters and return values. As such, they convey a lot of information for the documentation's user, when present.
See PEP 484 for a discussion of type hints.
Steps to Reproduce
Generate documentation for a module that uses type hints
Additional info
- pdoc version: 0.5.1
- Python version: 3.7.2 (default, Jan 3 2019, 02:55:40)