sphinx-autodoc-typehints
sphinx-autodoc-typehints copied to clipboard
Optional arguments - e.g. fun(var=None)
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
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.
A PR for this would be welcome.