Skip to content

DOC: update the Period.dayofweek attribute docstring #20280

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

Merged
merged 5 commits into from
Mar 13, 2018
Merged

DOC: update the Period.dayofweek attribute docstring #20280

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
eef375c
Added Doctring for Period dayofweek
hammadmashkoor Mar 11, 2018
952be06
Updated Doctring for Period dayofweek
hammadmashkoor Mar 11, 2018
3e25a7e
Updated Doctring for Period dayofweek
hammadmashkoor Mar 12, 2018
8072b21
Updated Docstring for perioddayofweek
hammadmashkoor Mar 13, 2018
de15589
Update period.pyx
jorisvandenbossche Mar 13, 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
31 changes: 31 additions & 0 deletions pandas/_libs/tslibs/period.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1246,6 +1246,37 @@ cdef class _Period(object):

@property
def dayofweek(self):
"""
Return the day of the week.

This attribute returns the day of the week on which the particular
Copy link
Contributor

Choose a reason for hiding this comment

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

If I'm not mistaken, this will return the day of the week on which the particular starting date for the given period occurs. I think this is important to mention, because at first I was confused thinking "how a period of one month can have a day of the week?".

Copy link
Member

Choose a reason for hiding this comment

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

Yes, we have this discussion in another PR as well (https://github.com/pandas-dev/pandas/pull/20277/files#r173651389). Only, it is not necessarily the starting date, it depends on the freq.

Copy link
Member

Choose a reason for hiding this comment

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

Issue is here: #20324.

date occurs with Monady=0, Sunday=6.
Copy link
Contributor

Choose a reason for hiding this comment

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

Monday


Returns
-------
Int:Range of 0 to 6
Copy link
Contributor

Choose a reason for hiding this comment

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

Not following the style guide, see https://python-sprints.github.io/pandas/guide/pandas_docstring.html#section-4-returns-or-yields


See also
--------
Period.dayofyear
Return the day of year.
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 do this in form of Period.dayofyear : Return the day of year. ? (same for one below)

Period.daysinmonth
Return the days in that month.

Examples
--------
>>> p=pd.Period('2012-1-1 19:00', freq='H')
Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Add spaces around p to follow flake8 also in docstrings.
  2. Perhaps better to use period for the variable name, it's short enough.

>>> p
Period('2012-01-01 19:00', 'H')
>>> p.dayofweek
6

>>> q=pd.Period('2013-1-9 11:00', freq='H')
>>> q
Period('2013-01-09 11:00', 'H')
>>> q.dayofweek
2
"""
base, mult = get_freq_code(self.freq)
return pweekday(self.ordinal, base)

Expand Down