Skip to content

Links on resample documentation page are broken #26275

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
larsrinn opened this issue May 3, 2019 · 1 comment · Fixed by #26306
Closed

Links on resample documentation page are broken #26275

larsrinn opened this issue May 3, 2019 · 1 comment · Fixed by #26306

Comments

@larsrinn
Copy link

larsrinn commented May 3, 2019

I meant to open an issue about inconsistent behaviour of resampling for sub- and super-daily intervals. When I was almost done, I discovered it's already been reported/discussed #9586

Figuring all of this out myself wasted a couple of hours, that could have been saved by a clearer documentation on the resample page: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.resample.html

Some things to change here:

  • The links under Notes are "broken" in a sense that the headers on the page they link to seem to be non-existing anymore. I guess the link labeled this link should go here: http://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#dateoffset-objects I'm unsure to which header user guide should link to.
  • The docstring for the rule parameter is confusing. It's type annotation says it's supposed to be a str but the description is The offset string or object representing target conversion. What kind of object can it be if not a string? And shouldn't this be in the type annotation then? Is it possible to link to some more information on this directly from the description of the parameter so it becomes immediately clear what the options are?
@WillAyd
Copy link
Member

WillAyd commented May 3, 2019

PRs to improve documentation are always welcome if you'd like to work on this!

@WillAyd WillAyd added the Docs label May 3, 2019
@WillAyd WillAyd added this to the Contributions Welcome milestone May 3, 2019
@jreback jreback modified the milestones: Contributions Welcome, 0.25.0 May 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants