Skip to content

#21128 DOC: Add documentation for freq='infer' option of DatetimeIndex and TimedeltaIndex constructors #21201

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

Closed
wants to merge 10 commits into from
Closed

#21128 DOC: Add documentation for freq='infer' option of DatetimeIndex and TimedeltaIndex constructors #21201

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
16452fc
#21128 adding documentation for freq in datetimes.py
May 25, 2018
3180573
#21128 adding documentation for freq in timedeltas.py
May 25, 2018
efbd4d1
#21128 adding examples for freq=infer field
May 25, 2018
aec1037
#21128 adding examples for freq=infer in timeseries.rst
May 25, 2018
daf1f86
21128 updating infer documentation in timedeltas.rst
May 25, 2018
e50abd3
21128 updating infer documentation in timeseries.rst
May 25, 2018
35164d5
21128 updating documentation for infer in datetimes.py
May 25, 2018
93163a6
21128 updating documentation for infer in timedeltas.py
May 25, 2018
38530b5
Merge branch 'master' of github.com:pandas-dev/pandas
May 25, 2018
e1a80eb
Merge branch 'master' of github.com:pandas-dev/pandas
May 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/source/timedeltas.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,12 @@ or ``np.timedelta64`` objects. Passing ``np.nan/pd.NaT/nat`` will represent miss
pd.TimedeltaIndex(['1 days', '1 days, 00:00:05',
np.timedelta64(2,'D'), datetime.timedelta(days=2,seconds=2)])

In [5]: pd.TimedeltaIndex(['0 days', '10 days', '20 days'])
Copy link
Member

Choose a reason for hiding this comment

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

I think you can remove this first example, since the existing example above is similar. I'm open to leaving this in though, if you'd rather keep this as a second example.

Out[5]: TimedeltaIndex(['0 days', '10 days', '20 days'], dtype='timedelta64[ns]', freq=None)

Copy link
Member

Choose a reason for hiding this comment

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

Can you add a sentence here to highlight the freq='infer' is being used here, and what it does, similar to the sentence added to the docstring.

In [4]: pd.TimedeltaIndex(['0 days', '10 days', '20 days'], freq='infer')
Copy link
Member

Choose a reason for hiding this comment

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

Can you put this in a .. ipython:: python block? A new block will need to be created if you add the sentence I suggested above. This essentially allows sphinx to generate the python output when the docs are being built. You'll only need to add the input line (without In [4]:) since the output will be generated. See the existing code sample a few lines above for an example of how to set this up.

Out[4]: TimedeltaIndex(['0 days', '10 days', '20 days'], dtype='timedelta64[ns]', freq='10D')

Generating Ranges of Time Deltas
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
7 changes: 7 additions & 0 deletions doc/source/timeseries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,13 @@ options like ``dayfirst`` or ``format``, so use ``to_datetime`` if these are req

pd.Timestamp('2010/11/12')

You can also use the `DatetimeIndex` constructor directly:
In [3]: pd.DatetimeIndex(['2018-01-01', '2018-01-03', '2018-01-05'])
Copy link
Member

Choose a reason for hiding this comment

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

Can you put this in a .. ipython:: python block? (same procedure as in my previous comment)

Out[3]: DatetimeIndex(['2018-01-01', '2018-01-03', '2018-01-05'], dtype='datetime64[ns]', freq=None)

Copy link
Member

Choose a reason for hiding this comment

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

Can you add a sentence here to highlight the freq='infer' is being used here and modify the example below in a .. ipython:: python block? (similar sentence as described in my timedeltas.rst comment)

Copy link
Member

Choose a reason for hiding this comment

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

Can you put the first DatetimeIndex example here (the one without freq='infer')?

In [2]: pd.DatetimeIndex(['2018-01-01', '2018-01-03', '2018-01-05'], freq='infer')
Out[2]: DatetimeIndex(['2018-01-01', '2018-01-03', '2018-01-05'], dtype='datetime64[ns]', freq='2D')

Providing a Format Argument
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
5 changes: 4 additions & 1 deletion pandas/core/indexes/datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,10 @@ class DatetimeIndex(DatelikeOps, TimelikeOps, DatetimeIndexOpsMixin,
copy : bool
Make a copy of input ndarray
freq : string or pandas offset object, optional
One of pandas date offset strings or corresponding objects
One of pandas date offset strings or corresponding objects. The string
'infer' can be passed in order to allow users to set the frequency of
Copy link
Member

Choose a reason for hiding this comment

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

I think this would be a little more direct if the "to allow users" is removed, so it just reads as "...in order to set the frequency...".

the index as the inferred frequency upon creation

start : starting value, datetime-like, optional
If data is None, start is used as the start point in generating regular
timestamp data.
Expand Down
5 changes: 4 additions & 1 deletion pandas/core/indexes/timedeltas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,10 @@ class TimedeltaIndex(DatetimeIndexOpsMixin, TimelikeOps, Int64Index):
Optional timedelta-like data to construct index with
unit: unit of the arg (D,h,m,s,ms,us,ns) denote the unit, optional
which is an integer/float number
freq: a frequency for the index, optional
freq : string or pandas offset object, optional
One of pandas date offset strings or corresponding objects. The string
'infer' can be passed in order to allow users to set the frequency of
Copy link
Member

Choose a reason for hiding this comment

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

same regarding "to allow users"

the index as the inferred frequency upon creation
copy : bool
Make a copy of input ndarray
start : starting value, timedelta-like, optional
Expand Down