Update docs based on Python type hints #524
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It was quite easy to add https://pypi.org/project/sphinx-autodoc-typehints to
docs/requirements.txt
and then generate docs based on Python type hints that look like this:This enables us to remove a fair amount of repetitive (and somewhat erroneous) typing information from method docstrings. These lines can all be remove from docstrings:
grep ":type " **/*.py
andgrep ":rtype:" **/*.py
@JustAnotherArchivist @maxz ... Might be of interest.