Skip to content

DOC : Update the Period.second docstring #20319

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

Jump to bottom
Merged
merged 2 commits into from
Mar 13, 2018
Merged

DOC : Update the Period.second docstring #20319

merged 2 commits into from
Mar 13, 2018

Conversation

IHackPy
Copy link
Contributor

@IHackPy IHackPy commented Mar 13, 2018 •
edited by TomAugspurger
Loading 

# Period.second
############################################################################
####################### Docstring (pandas.Period.second) #######################
################################################################################

Get second of the minute component of the Period.

Returns
-------
int 
    The second as an integer, between 0 and 59.

See Also
--------
Period.hour : Get the hour component of the Period.
Period.minute : Get the minute component of the Period.

Examples
--------
>>> p = pd.Period("2018-03-11 13:03:12.050000")
>>> p.second
12

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

WillAyd
WillAyd requested changes Mar 13, 2018
View reviewed changes
pandas/_libs/tslibs/period.pyx Outdated
@@ -1295,6 +1295,25 @@ cdef class _Period(object):

@property
def second(self):
"""
Get second of the minute component of the Period.
Copy link
Member

Choose a reason for hiding this comment

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

Say the same thing you are saying in See Also but for second, so literally "Get the second component of the Period"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

but period I'm bit confusesd because when I ren code it gives that particular second of that minute have

Copy link
Member

Choose a reason for hiding this comment

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

Not sure I understand your comment. The below will both return 12, so the minute is irrelevant:

pd.Period("2018-03-11 13:03:12.050000").second
pd.Period("2018-03-11 13:04:12.050000").second

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yup I made changes 👍 thanks for reveiw

pandas/_libs/tslibs/period.pyx Outdated
Returns
-------
int
The second as an integer, between 0 and 59.
Copy link
Member

@WillAyd WillAyd Mar 13, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Already said second is an int above so no need to restate here. Maybe better worded as "The second of the Period (ranges from 0 to 59)"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yup sure :+1

@codecov
Copy link

codecov bot commented Mar 13, 2018

Codecov Report

Merging #20319 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #20319   +/-   ##
=======================================
  Coverage   91.72%   91.72%           
=======================================
  Files         150      150           
  Lines       49165    49165           
=======================================
  Hits        45099    45099           
  Misses       4066     4066
Flag Coverage Δ
#multiple 90.11% <ø> (ø) ⬆️
#single 41.86% <ø> (ø) ⬆️

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 31afaf8...2188f80. Read the comment docs.

@WillAyd
Copy link
Member

WillAyd commented Mar 13, 2018

lgtm

@IHackPy
Copy link
Contributor Author

IHackPy commented Mar 13, 2018

Thanks @WillAyd

@jreback jreback added Docs Period Period data type labels Mar 13, 2018
@TomAugspurger TomAugspurger merged commit 730f9b6 into pandas-dev:master Mar 13, 2018
@TomAugspurger
Copy link
Contributor

Thanks!

@IHackPy
Copy link
Contributor Author

IHackPy commented Mar 13, 2018

thanks

@jorisvandenbossche jorisvandenbossche added this to the 0.23.0 milestone Mar 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@WillAyd WillAyd WillAyd requested changes

Assignees
No one assigned
Labels
Docs Period Period data type
Projects
None yet
Milestone
0.23.0
Development

Successfully merging this pull request may close these issues.
5 participants
@IHackPy @WillAyd @TomAugspurger @jreback @jorisvandenbossche