DOC: do not include type hints in signature in html docs #33312
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Can you post a screenshot of the output? The types are just completely hidden from the signature? |
Member
Author
|
It simply removed type hints from the signature, so you get
instead of
using the example from #33025 (but there are other pages that have much more elaborate type hints, where the improvement in readability is bigger) |
Member
|
lgtm |
TomAugspurger
approved these changes
Apr 6, 2020
datapythonista
approved these changes
Apr 6, 2020
Member
datapythonista
left a comment
datapythonista
left a comment
There was a problem hiding this comment.
lgtm. Can you merge master? CI should be fix I think
Member
|
LGTM |
Contributor
|
I think @WillAyd had thoughts in the issue. Are you OK with disabling them until we can provide a better UI for controlling whether you want to see them or not? |
Member
|
lgtm |
Contributor
|
Thanks for confirming. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
See #33025. Removing the type hints in the online docs until we have a better solution to improve readability.