Skip to content

DOC: DataFrame.resample docs could be improved #14843

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

Closed
jreback opened this issue Dec 9, 2016 · 3 comments
Closed

DOC: DataFrame.resample docs could be improved #14843

jreback opened this issue Dec 9, 2016 · 3 comments
Labels
Docs Resample resample method

Comments

@jreback
Copy link
Contributor

jreback commented Dec 9, 2016

http://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.resample.html?highlight=dataframe%20resample#pandas.DataFrame.resample

These are the same docs for both Series & DataFrame. so might be nice to add some DataFrame examples (and use on / axis parameters). So may need to move these to a shared_docs template to suppport this.

@jreback jreback added this to the Next Major Release milestone Dec 9, 2016
@rishikksh20
Copy link

There is one more issue in this page where following link not formatted :
To learn more about the offset strings, please see ` this link
http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases`__.

I can take this issue. Please guide me little bit about docs and shared_docs template.

@jorisvandenbossche
Copy link
Member

@jreback this might be closed by #15627. But there we choose to just add example for DataFrame in the existing docstring (so have a unified docstring for Series and DataFrame with examples for both).
But in principle we could also split off the examples and only add those relevant to Series or DataFrame (but not sure if I find this worth the complexity here).

@jreback
Copy link
Contributor Author

jreback commented Mar 9, 2017

in this case i think this is fine

resample is pretty much the same (meaning signature is the same), unlike say sort_values for Series/Dataframe

@jreback jreback closed this as completed Mar 9, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Resample resample method
Projects
None yet
Development

No branches or pull requests

3 participants