Skip to content
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.

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

DOC: do we want type hints in signature on API pages? #28585

Closed
jorisvandenbossche opened this issue Sep 23, 2019 · 2 comments
Closed

DOC: do we want type hints in signature on API pages? #28585

jorisvandenbossche opened this issue Sep 23, 2019 · 2 comments
Labels

Comments

@jorisvandenbossche
Copy link
Member

With the type hints that are being added in a lot of places, the question comes up if we want to have them in the docs.

Currently, this actually happens. See eg https://dev.pandas.io/docs/reference/api/pandas.DataFrame.to_string.html#pandas.DataFrame.to_string

image

But personally, I am not sure the having the type hints in the signature like above is an improvement. It makes the signature very hard to read and interpret, while we (in principle) already have the type information in textual form in the Parameter listing.

@WillAyd
Copy link
Member

WillAyd commented Sep 24, 2019

I think these are good to have; serving as a form of documentation is one of the motivators for annotations

@TomAugspurger
Copy link
Contributor

Closing in favor of #33025, which has a couple links to workarounds.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants