DOC : update the pandas.Period.weekday docstring #20413

IHackPy · 2018-03-19T18:47:20Z

Period.weekday

################################################################################
###################### Docstring (pandas.Period.weekday) ######################
################################################################################

Get day of the week that a Period falls on.

Returns

int

Examples

p = pd.Period("2018-03-11", "H")
p.weekday
6

p = pd.Period("2018-02-01", "D")
p.weekday
3

p = pd.Period("2018-01-06", "D")
p.weekday
5

################################################################################
################################## Validation ##################################
################################################################################

codecov · 2018-03-19T21:33:20Z

Codecov Report

Merging #20413 into master will decrease coverage by 0.16%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #20413      +/-   ##
==========================================
- Coverage   91.96%    91.8%   -0.17%     
==========================================
  Files         166      152      -14     
  Lines       50331    49205    -1126     
==========================================
- Hits        46289    45171    -1118     
+ Misses       4042     4034       -8

Flag	Coverage Δ
#multiple	`90.18% <ø> (-0.18%)`	⬇️
#single	`41.85% <ø> (-0.38%)`	⬇️

Impacted Files	Coverage Δ
pandas/io/s3.py	`72.72% <0%> (-13.64%)`	⬇️
pandas/util/_doctools.py	`0% <0%> (-12.88%)`	⬇️
pandas/core/arrays/base.py	`80.64% <0%> (-7.22%)`	⬇️
pandas/io/formats/terminal.py	`16.43% <0%> (-4.55%)`	⬇️
pandas/io/formats/printing.py	`89.38% <0%> (-3.71%)`	⬇️
pandas/core/dtypes/missing.py	`91.07% <0%> (-2.5%)`	⬇️
pandas/io/common.py	`68.77% <0%> (-1.88%)`	⬇️
pandas/util/testing.py	`83.95% <0%> (-1.74%)`	⬇️
pandas/core/reshape/tile.py	`93.37% <0%> (-1.37%)`	⬇️
pandas/core/indexes/interval.py	`93.08% <0%> (-1.23%)`	⬇️
... and 91 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ce87d06...fcaaf4b. Read the comment docs.

datapythonista · 2018-03-23T13:35:17Z

pandas/_libs/tslibs/period.pyx

@@ -1416,6 +1416,32 @@ cdef class _Period(object):

    @property
    def weekday(self):
+        """
+        Get day of the week that a Period falls on.


As this is a property and not a function, no need to start with a verb, you can start with "Day of the week...".

Also, as Period here is the pandas object, you can use backticks to highlight it.

I think in the extended summary you could explain that 0 means Monday...

datapythonista · 2018-03-23T13:36:03Z

pandas/_libs/tslibs/period.pyx

+
+        See Also
+        --------
+        Period.dayofweek : Get the day component of the Period.


From the description, I can't see the difference between weekday and dayofweek. Can you clarify it please?

yup sure 👍

datapythonista · 2018-03-23T13:42:30Z

pandas/_libs/tslibs/period.pyx

+        --------
+        >>> p = pd.Period("2018-03-11", "H")
+        >>> p.weekday
+        6


I think the examples give the idea that a Period is a single day. I'd use a Period for a quarter that should make it clearer that this is not a single day.

And also, or here or in the summary, give more details on which day of the week of the 3 months period is being returned.

…riod.weekday

datapythonista · 2018-07-09T22:59:37Z

@jbrockmendel do you mind reviewing this docstring? (both are the same, we can't reuse in this case)

jbrockmendel · 2018-07-10T04:08:36Z

pandas/_libs/tslibs/period.pyx

-        >>> period2
-        Period('2013-01-09 11:00', 'H')
-        >>> period2.dayofweek
+        For periods with a frequancy higher than days, the last day of the


typo frequency

jbrockmendel · 2018-07-10T04:09:08Z

pandas/_libs/tslibs/period.pyx

+        >>> per.start_time.dayofweek
+        6
+
+        For periods with a frequancy higher than days, the last day of the


typo frequency

jbrockmendel · 2018-07-10T04:10:55Z

pandas/_libs/tslibs/period.pyx

+        """
+        # Docstring is a duplicate from dayofweek. Reusing docstrings with
+        # Appender doesn't work for properties in Cython files, and setting
+        # the __doc__ attribute is also not possible.


Would it work using syntax to the effect of weekday = property(dayofweek.fget, doc=dayofweek.__doc__)?

Thanks for the feedback. That's actually a great idea, didn't know property had an argument for the doc. Unfortunately this doesn't seem to be supported in cython:

weekday = property(dayofweek.fget, doc=dayofweek.__doc__) ^ ------------------------------------------------------------ pandas/_libs/tslibs/period.pyx:1430:23: 'dayofweek' is not a constant, variable or function identifier

jbrockmendel · 2018-07-10T04:11:48Z

Pending typo fixups, LGTM.

…riod.weekday

datapythonista · 2018-07-18T09:53:06Z

Thanks @IHackPy for the PR, and thanks @jbrockmendel for the reviews.

IHackPy · 2018-07-19T01:17:31Z

Thanks Marc ! and sorry I forget to complete some string I thought . I will update soon.

…

On Wed, Jul 18, 2018 at 3:23 PM, Marc Garcia ***@***.***> wrote: Thanks @IHackPy <https://github.com/IHackPy> for the PR, and thanks @jbrockmendel <https://github.com/jbrockmendel> for the reviews. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#20413 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AV3rxUjxkNSmABFkgy8Ls3fZiDOhnRYiks5uHwWagaJpZM4SwtDn> .

-- Thanks and Regards Himanshu Awasthi, Freelancer & Enthusiastic Engineering Student KanpurFOSS Community +91 7310476826 |Twitter @IHackPy <https://twitter.com/IHackPY>

…ev#20413)

DOC : update docstring

c9282d7

jreback added Docs Period Period data type labels Mar 19, 2018

datapythonista reviewed Mar 23, 2018

View reviewed changes

datapythonista added 2 commits July 9, 2018 14:44

Merge remote-tracking branch 'upstream/master' into docstring_head.pe…

45a7754

…riod.weekday

Being more specific on what dayofweek returns for periods

82084bf

jbrockmendel reviewed Jul 10, 2018

View reviewed changes

datapythonista added 2 commits July 17, 2018 20:48

Merge remote-tracking branch 'upstream/master' into docstring_head.pe…

eaf6c77

…riod.weekday

Fixed typo in docstring

fcaaf4b

datapythonista merged commit 1ce2473 into pandas-dev:master Jul 18, 2018

aeltanawy pushed a commit to aeltanawy/pandas that referenced this pull request Jul 20, 2018

DOC : Update the Period.dayofweek/Period.weekday docstring (pandas-d…

f8b1e5e

…ev#20413)

Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018

DOC : Update the Period.dayofweek/Period.weekday docstring (pandas-d…

40ccccf

…ev#20413)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC : update the pandas.Period.weekday docstring #20413

DOC : update the pandas.Period.weekday docstring #20413

IHackPy commented Mar 19, 2018

codecov bot commented Mar 19, 2018 •

edited

Loading

datapythonista Mar 23, 2018

datapythonista Mar 23, 2018

IHackPy Mar 23, 2018

datapythonista Mar 23, 2018

datapythonista commented Jul 9, 2018

jbrockmendel Jul 10, 2018

jbrockmendel Jul 10, 2018

jbrockmendel Jul 10, 2018

datapythonista Jul 17, 2018

jbrockmendel commented Jul 10, 2018 •

edited

Loading

datapythonista commented Jul 18, 2018

IHackPy commented Jul 19, 2018 via email

DOC : update the pandas.Period.weekday docstring #20413

DOC : update the pandas.Period.weekday docstring #20413

Conversation

IHackPy commented Mar 19, 2018

Period.weekday

Returns

See Also

Examples

codecov bot commented Mar 19, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

datapythonista commented Jul 9, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jbrockmendel commented Jul 10, 2018 • edited Loading

datapythonista commented Jul 18, 2018

IHackPy commented Jul 19, 2018 via email

codecov bot commented Mar 19, 2018 •

edited

Loading

jbrockmendel commented Jul 10, 2018 •

edited

Loading