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

.resample documentation too vague #16257

Closed
eddy-ojb opened this issue May 5, 2017 · 2 comments
Closed

.resample documentation too vague #16257

eddy-ojb opened this issue May 5, 2017 · 2 comments
Labels
Docs Duplicate Report Duplicate issue or pull request Resample resample method

Comments

@eddy-ojb
Copy link

eddy-ojb commented May 5, 2017

Problem description: ".resample" documentation too vague

url: http://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.resample.html

e.g.:

rule: "The offset string or object representing target conversion"

No idea what is meant by that but a more helpful description to amateurs like me seems to be e.g.:
'a frequency or valid rule for re-sampling an inputted time-series object. Expressed as a string. '

Where is the documentation on 'how'? Or is it deprecated. If so, why is it there?

There are 13 parameters with only 9 descriptions.

Lastly, I think that if documentation is structured, a better suited layout is in the form of tables with clear headers but I suppose the documentation is too far in for anyone to be motivated to change it!

Best

Ed

@jreback
Copy link
Contributor

jreback commented May 5, 2017

certainly would take a pull request to add a link to the main docs - these doc strings are more for reference

http://pandas.pydata.org/pandas-docs/stable/timeseries.html#resampling

@jreback jreback added Docs Duplicate Report Duplicate issue or pull request Resample resample method labels May 5, 2017
@jreback jreback added this to the No action milestone May 5, 2017
@jreback
Copy link
Contributor

jreback commented May 5, 2017

duplicate of #5023

@jreback jreback closed this as completed May 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Duplicate Report Duplicate issue or pull request Resample resample method
Projects
None yet
Development

No branches or pull requests

2 participants