From 8267a89c594cd70e79f88dcbfcfcd949c9f86c39 Mon Sep 17 00:00:00 2001 From: "Warmerdam, Vincent" Date: Sat, 10 Mar 2018 20:56:16 +0100 Subject: [PATCH 1/4] base docstring added --- pandas/core/indexes/datetimes.py | 60 ++++++++++++++++++++++++++++++-- 1 file changed, 58 insertions(+), 2 deletions(-) diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index e5e9bba269fd4..1ffd1654d0c50 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -1707,8 +1707,64 @@ def freq(self, value): weekofyear = _field_accessor('weekofyear', 'woy', "The week ordinal of the year") week = weekofyear - dayofweek = _field_accessor('dayofweek', 'dow', - "The day of the week with Monday=0, Sunday=6") + _dayofweek_doc = """ + 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. + + See Also + -------- + pandas.Series.dt.dayofweek : Identical method. + pandas.Series.dt.weekday : Identical method. + + Returns + ------- + ndarray of integers indicating the day of the week + + Examples + -------- + >>> dates = pd.date_range("2016-12-31", "2017-01-08", freq="D") + >>> series = pd.Series(dates) + >>> pd.DataFrame({'dt': series, 'num': series.dt.weekday, 'day':series.dt.strftime("%A")}) + dt num day + 0 2016-12-31 5 Saturday + 1 2017-01-01 6 Sunday + 2 2017-01-02 0 Monday + 3 2017-01-03 1 Tuesday + 4 2017-01-04 2 Wednesday + 5 2017-01-05 3 Thursday + 6 2017-01-06 4 Friday + 7 2017-01-07 5 Saturday + 8 2017-01-08 6 Sunday + + Note what `series.dt.dayofweek` and `series.dt.weekday` are the same. + + >>> series.dt.dayofweek + 0 5 + 1 6 + 2 0 + 3 1 + 4 2 + 5 3 + 6 4 + 7 5 + 8 6 + dtype: int64 + >>> series.dt.weekday + 0 5 + 1 6 + 2 0 + 3 1 + 4 2 + 5 3 + 6 4 + 7 5 + 8 6 + dtype: int64 + """ + dayofweek = _field_accessor('dayofweek', 'dow', _dayofweek_doc) weekday = dayofweek weekday_name = _field_accessor( From 890e8e55d306034c545fd8bf48e3cfab72fa0113 Mon Sep 17 00:00:00 2001 From: "Warmerdam, Vincent" Date: Sat, 10 Mar 2018 21:14:39 +0100 Subject: [PATCH 2/4] added dayofweek docstring --- pandas/core/indexes/datetimes.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index 1ffd1654d0c50..692e74f8b4a49 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -1710,9 +1710,9 @@ def freq(self, value): _dayofweek_doc = """ 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. + 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. See Also -------- @@ -1726,8 +1726,9 @@ def freq(self, value): Examples -------- >>> dates = pd.date_range("2016-12-31", "2017-01-08", freq="D") - >>> series = pd.Series(dates) - >>> pd.DataFrame({'dt': series, 'num': series.dt.weekday, 'day':series.dt.strftime("%A")}) + >>> s = pd.Series(dates) + >>> day_name = s.dt.strftime("%A") + >>> pd.DataFrame({'dt': s, 'num': s.dt.weekday, 'day': day_name}) dt num day 0 2016-12-31 5 Saturday 1 2017-01-01 6 Sunday @@ -1739,9 +1740,9 @@ def freq(self, value): 7 2017-01-07 5 Saturday 8 2017-01-08 6 Sunday - Note what `series.dt.dayofweek` and `series.dt.weekday` are the same. + Note that `series.dt.dayofweek` and `series.dt.weekday` are the same. - >>> series.dt.dayofweek + >>> s.dt.dayofweek 0 5 1 6 2 0 @@ -1752,7 +1753,7 @@ def freq(self, value): 7 5 8 6 dtype: int64 - >>> series.dt.weekday + >>> s.dt.weekday 0 5 1 6 2 0 From 96abd3ac63a9429808e00bffbb2e38b095551f78 Mon Sep 17 00:00:00 2001 From: "Warmerdam, Vincent" Date: Sat, 10 Mar 2018 22:26:42 +0100 Subject: [PATCH 3/4] series => Series and better return desc --- pandas/core/indexes/datetimes.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index 692e74f8b4a49..695a90d4f7fa9 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -1712,7 +1712,8 @@ def freq(self, value): 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. + by 6. This method is available on both Series with datetime + values or DatetimeIndex See Also -------- @@ -1721,6 +1722,9 @@ def freq(self, value): Returns ------- + Series + Containing integers indicating the week number. + ndarray of integers indicating the day of the week Examples @@ -1740,7 +1744,7 @@ def freq(self, value): 7 2017-01-07 5 Saturday 8 2017-01-08 6 Sunday - Note that `series.dt.dayofweek` and `series.dt.weekday` are the same. + Note: `pandas.Series.dt.dayofweek`/`pandas.Series.dt.weekday` are the same. >>> s.dt.dayofweek 0 5 From 896d75c3cd6af3d3cff0fe142bd63fb98fbaa8d7 Mon Sep 17 00:00:00 2001 From: "Warmerdam, Vincent" Date: Sat, 10 Mar 2018 22:33:49 +0100 Subject: [PATCH 4/4] series type => ndarray" --- pandas/core/indexes/datetimes.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index 695a90d4f7fa9..aeac5e03de54a 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -1722,10 +1722,8 @@ def freq(self, value): Returns ------- - Series - Containing integers indicating the week number. - - ndarray of integers indicating the day of the week + ndarray + Containing integers indicating the day number. Examples --------