Construct docstring Args sections from signatures

[USSX-Hares]

It would be nice to automatically generate function/method argument types from its signature
(i.e., by calling inspect.signature) if the docstring provides no such information.

It would be helpful in linking the difficult types.
However, it can go wrong with the TypeVar's.

def my_func(a: str, b: str = 'test', *, z: str) -> str:
    """
    Some documentation here
    """
    
    pass

Expected Behavior

Something like that

Actual Behavior

Additional info

• pdoc version: 0.6.3.

[kernc]

Have a look at show_type_annotations config tunable.

pdoc/pdoc/templates/config.mako

Line 9 in 44c9606

show_type_annotations = False

You can set it by running pdoc as

pdoc --config show_type_annotations=True ...

It's not exactly what you ask here (won't create or modify prose text sections), but it should make the declared types visible in the signature.

[kernc]

It so stands that Python projects should foremost be documented via code and then via docstrings. Automatic code generation (i.e. inserting missing docstrings) is out of scope for pdoc, but should instead be handled at an IDE / project build level. As an IDE, PyCharm offers to auto-generate docstrings similar to above, with several styles to choose from (Numpydoc, Google, reST, ...).