DOC: Fixed examples in pandas/core/indexes/

[ShaharNaveh]

• closes #xxxx
• tests added / passed
• passes black pandas
• passes git diff upstream/master -u -- "*.py" | flake8 --diff
• whatsnew entry

[WillAyd]

lgtm

[ShaharNaveh]

Forgot to mention, I could not manage to give an example for s.dt.hours,

I tried to have:

import pandas as pd
hours_series = pd.Series(pd.timedelta_range(start="1 day", periods=3, freq="H"))

And then:

hours_series.dt.hours

and

 hours_series.dt.hour

but both gives:

AttributeError: 'TimedeltaProperties' object has no attribute 'hour'
AttributeError: 'TimedeltaProperties' object has no attribute 'hours'

[simonjayhawkins]

can you see if there is an issue for this.

>>> s = pd.Series(pd.timedelta_range(start="1 day", periods=3, freq="H"))
>>> s
0   1 days 00:00:00
1   1 days 01:00:00
2   1 days 02:00:00
dtype: timedelta64[ns]
>>>
>>> s.dt.components
   days  hours  minutes  seconds  milliseconds  microseconds  nanoseconds
0     1      0        0        0             0             0            0
1     1      1        0        0             0             0            0
2     1      2        0        0             0             0            0

[ShaharNaveh]

I could not find an issue for this, so I opened one here:

xref #33255

[simonjayhawkins]

I wonder whether needs to be in the class description.

with help(pd.core.indexes.accessors.DatetimeProperties)

under Data descriptors defined here:

we have

| dayofweek
| The day of the week with Monday=0, Sunday=6.
|
| Return the day of the week. It is assumed the week starts on
| Monday, which is denoted by 0 and ends on Sunday which is denoted
| by 6. This method is available on both Series with datetime
| values (using the dt accessor) or DatetimeIndex.
|

Returns
Series or Index
Containing integers indicating the day number.

|

See Also
Series.dt.dayofweek : Alias.
Series.dt.weekday : Alias.
Series.dt.day_name : Returns the name of the day of the week.

|

Examples
>>> s = pd.date_range('2016-12-31', '2017-01-08', freq='D').to_series()
>>> s.dt.dayofweek
2016-12-31 5
2017-01-01 6
2017-01-02 0
2017-01-03 1
2017-01-04 2
2017-01-05 3
2017-01-06 4
2017-01-07 5
2017-01-08 6
Freq: D, dtype: int64

and for hour, second and quarter we just have

| hour
| The hours of the datetime.

second
| The seconds of the datetime.

| quarter
| The quarter of the date.

maybe these examples should be in the descriptor docstrings instead. wdyt?

[ShaharNaveh]

I believe that we should have them for both, because the class's docstring is telling the user/developer that this class is responsible for accessing the fields, and some examples on.

And on top of that we should also supply specific examples for each field accessor, would love to do so in a follow up.

[simonjayhawkins]

@MomIsBestFriend lgtm. ping on green

[ShaharNaveh]

ping @simonjayhawkins

[simonjayhawkins]

Thanks @MomIsBestFriend