Skip to content

API documentation should state return types #17114

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
Closed
fulldecent opened this issue Jul 29, 2017 · 2 comments
Closed

API documentation should state return types #17114

fulldecent opened this issue Jul 29, 2017 · 2 comments
Labels
Docs Dtype Conversions Unexpected or buggy dtype conversions

Comments

@fulldecent
Copy link

As an example, let's see the documentation for pandas.DataFrame.dtypes:

Documentation:

DataFrame.dtypes
Return the dtypes in this object.

https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.dtypes.html

This documentation is insufficient to describe the function. Perhaps a better documentation would state something like:

DataFrame.dtypes

Return a series of dtypes in this object.
Return type is pandas.core.series.Series with elements of numpy.dtype.

And those two types should link to related to documentation if available.
@jreback
Copy link
Contributor

jreback commented Jul 29, 2017

sure there are doc strings that could use updating

@gfyoung gfyoung added Docs Dtype Conversions Unexpected or buggy dtype conversions labels Jul 29, 2017
@jorisvandenbossche jorisvandenbossche mentioned this issue Jul 31, 2017
Closed
@TomAugspurger
Copy link
Contributor

This has been fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs Dtype Conversions Unexpected or buggy dtype conversions
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@fulldecent @jreback @TomAugspurger @gfyoung