Optional arguments - e.g. fun(var=None)

tox-dev / sphinx-autodoc-typehints

Type hints support for the Sphinx autodoc extension

MIT License

552 stars 103 forks source link

Optional arguments - e.g. fun(var=None) #175

Open gitPrinz opened 3 years ago

gitPrinz commented 3 years ago

Parameters can be optional with a default value.

some_function(some_variable: some_type = default_value)

Is there any possibility to show this in the variable description?

For Example this could be solved

after the type hint by (some_type - default: default_value)
or as extra line below the description

agronholm commented 3 years ago

This has come up more than once, and I'll consider it. This project is not on my priority list, however, and I'm looking for a new maintainer so don't expect this to materialize soon.

gaborbernat commented 2 years ago

A PR for this would be welcome.