-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: update the Period.daysinmonth docstring #20295
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.
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
DOC: update the Period.daysinmonth docstring #20295
Conversation
xref #20294 a lot of the feedback will be similar |
sure will work on both Thaks for reviewing |
Codecov Report
@@ Coverage Diff @@
## master #20295 +/- ##
==========================================
+ Coverage 91.7% 91.73% +0.02%
==========================================
Files 150 150
Lines 49168 49168
==========================================
+ Hits 45090 45102 +12
+ Misses 4078 4066 -12
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small comment, looks good for the rest
pandas/_libs/tslibs/period.pyx
Outdated
@@ -1275,6 +1275,25 @@ cdef class _Period(object): | |||
|
|||
@property | |||
def daysinmonth(self): | |||
""" | |||
Get total days of month that a Period falls on. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would maybe rephrase this as "Get the total number of days of the month that the Period falls in"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure will update now . As I'm not good in making sentences thanks for guiding :) 👍
pandas/_libs/tslibs/period.pyx
Outdated
See Also | ||
-------- | ||
Period.days_in_month : Return the days of the month | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no blank line is needed here
@jorisvandenbossche why ci test fail here ? |
ignore the ci i have had to cancel most jobs |
@himanshuawasthi95 Thanks! |
thank u @jorisvandenbossche @WillAyd @jreback |
Period.daysinmonth
################################################################################
#################### Docstring (pandas.Period.daysinmonth) ####################
################################################################################
Return total number of days of the month in given Period.
This attribute returns the total number of days of given month
Returns
Int
Number of days with in month
See also
Period.dayofweek
Return the day of the week
Period.dayofyear
Return the day of the year
Examples
################################################################################
################################## Validation ##################################
################################################################################
Docstring for "pandas.Period.daysinmonth" correct. :)