huggingface / huggingface/doc-builder
Allow disabling typehints in API signatures
- Dominant language
- Python
- Stars
- 144
- Forks
- 59
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 13
Description
Showing type hints can make the rendered version of the docs quite unreadable, and it'd be nice to be able to disable that. In Sphinx you could do that by [setting a parameter](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints).
An example of where it'd be nice not to have type hints is this one:

Especially since we repeat the types in our docstrings, they don't need to be present in the method/function signature.
cc @LysandreJik
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.