Skip to content

DOC: Add infer frequency to docs #10053

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

Merged
merged 1 commit into from
May 5, 2015
Merged

Conversation

jnmclarty
Copy link
Contributor

Was there a reason infer_freq and inferred_freq weren't in the docs? Did I pick the right spot to add it? Does the feature work well?

I set out looking for a feature like this, searching "guess frequency", "auto detect frequency".

@jreback jreback added Docs Frequency DateOffsets labels May 4, 2015
@jreback jreback added this to the 0.16.1 milestone May 4, 2015
@@ -1364,6 +1365,7 @@ Time/Date Components
DatetimeIndex.is_quarter_end
DatetimeIndex.is_year_start
DatetimeIndex.is_year_end
DatetimeIndex.inferred_freq
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is also defined for TimedeltaIndex

@jreback
Copy link
Contributor

jreback commented May 4, 2015

minor change, ping when pushed.

@jorisvandenbossche
Copy link
Member

@jnmclarty Could you also update the infer_freq docstring with:

  • it also works for TimedeltaIndex
  • it raises a ValueError when not having 3 values? (now it only mentions a TypeError when the the provided values are no DatetimeIndex)

@jreback
Copy link
Contributor

jreback commented May 4, 2015

@jorisvandenbossche side issue, we don't appear to have PeriodIndex at all in api.rst....do we have an issue for this?

@jorisvandenbossche
Copy link
Member

Ideally, we should also resolve this one: #5082

@jorisvandenbossche
Copy link
Member

On the PeriodIndex API docs: yes, the issue is here: #6384

@jreback
Copy link
Contributor

jreback commented May 4, 2015

@jorisvandenbossche on #5082

In reality, I just think we could just fix infer_freq & infered_freq to return an actual offset object (which reprs to a string). rather than adding addtional methods. These compare correctly to strings anyhow.

@jnmclarty
Copy link
Contributor Author

@jreback Okay to merge.

jreback added a commit that referenced this pull request May 5, 2015
DOC: Add infer frequency to docs
@jreback jreback merged commit 3aa8778 into pandas-dev:master May 5, 2015
@jreback
Copy link
Contributor

jreback commented May 5, 2015

thanks!

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

Successfully merging this pull request may close these issues.

3 participants