Hide typehints in API documentation #41
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.
Description
This PR proposes to remove type annotations/hints from the autogenerated API documentation using the autodoc_typehints setting.
Typehints can be distracting and are repeated in numpy docstrings anyways. If needed, the typehints are one click away in the
[source]
link. Here's a comparison ofPhasorPlot.semicircle
method with and without typehints:Release note
Summarize the changes in the code block below to be included in the
release notes:
Checklist