Skip to content

DOC: do not include type hints in signature in html docs #33312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Apr 6, 2020
Merged

DOC: do not include type hints in signature in html docs #33312

merged 2 commits into from
Apr 6, 2020

Conversation

jorisvandenbossche
Copy link
Member

See #33025. Removing the type hints in the online docs until we have a better solution to improve readability.

@simonjayhawkins simonjayhawkins added this to the 1.1 milestone Apr 6, 2020
@TomAugspurger
Copy link
Contributor

TomAugspurger commented Apr 6, 2020 •
edited
Loading

Can you post a screenshot of the output? The types are just completely hidden from the signature?

@jorisvandenbossche
Copy link
Member Author

It simply removed type hints from the signature, so you get

image

instead of

image

using the example from #33025 (but there are other pages that have much more elaborate type hints, where the improvement in readability is bigger)

@simonjayhawkins
Copy link
Member

lgtm

datapythonista
datapythonista approved these changes Apr 6, 2020
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. Can you merge master? CI should be fix I think

@jbrockmendel
Copy link
Member

LGTM

@TomAugspurger
Copy link
Contributor

TomAugspurger commented Apr 6, 2020 •
edited
Loading

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?

@WillAyd
Copy link
Member

WillAyd commented Apr 6, 2020

lgtm

@TomAugspurger
Copy link
Contributor

Thanks for confirming.

@TomAugspurger TomAugspurger merged commit 522461f into pandas-dev:master Apr 6, 2020
@jorisvandenbossche jorisvandenbossche deleted the docstrings-types branch April 6, 2020 20:55
jbrockmendel pushed a commit to jbrockmendel/pandas that referenced this pull request Apr 11, 2020
@jorisvandenbossche @jbrockmendel
DOC: do not include type hints in signature in html docs (pandas-dev#…
9585a41 
…33312)
@simonjayhawkins simonjayhawkins mentioned this pull request May 8, 2020
Closed
@TomAugspurger TomAugspurger mentioned this pull request May 20, 2020
Closed
@simonjayhawkins simonjayhawkins mentioned this pull request Sep 19, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAugspurger TomAugspurger TomAugspurger approved these changes

@datapythonista datapythonista datapythonista approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
1.1
Development

Successfully merging this pull request may close these issues.
6 participants
@jorisvandenbossche @TomAugspurger @simonjayhawkins @jbrockmendel @WillAyd @datapythonista