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

Merged
merged 2 commits into from
Mar 13, 2018
Merged

DOC : Update the Period.second docstring #20319

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c6b3e8
Update the Period.second docstring
IHackPy Mar 13, 2018
2188f80
UPdate required change
IHackPy 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
19 changes: 19 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 @@ -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


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


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
"""
base, mult = get_freq_code(self.freq)
return psecond(self.ordinal, base)

Expand Down