Skip to content

DOC: Fixing EX01 - Added examples #53274

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 3 commits into from
May 17, 2023
Merged

DOC: Fixing EX01 - Added examples #53274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ddd0ba
Added Examples
DeaMariaLeon May 17, 2023
7fb10a7
Added examples
DeaMariaLeon May 17, 2023
11b47e7
corrected code_checks
DeaMariaLeon May 17, 2023
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
5 changes: 0 additions & 5 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,11 +169,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.Timedelta.to_numpy \
pandas.Timedelta.total_seconds \
pandas.arrays.TimedeltaArray \
pandas.Period.freqstr \
pandas.Period.is_leap_year \
pandas.Period.month \
pandas.Period.quarter \
pandas.Period.year \
pandas.Period.asfreq \
pandas.Period.now \
pandas.arrays.PeriodArray \
Expand Down
33 changes: 33 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 @@ -1984,6 +1984,12 @@ cdef class _Period(PeriodMixin):
def year(self) -> int:
"""
Return the year this Period falls on.

Examples
--------
>>> period = pd.Period('2022-01', 'M')
>>> period.year
2022
"""
base = self._dtype._dtype_code
return pyear(self.ordinal, base)
Expand All @@ -1992,6 +1998,12 @@ cdef class _Period(PeriodMixin):
def month(self) -> int:
"""
Return the month this Period falls on.

Examples
--------
>>> period = pd.Period('2022-01', 'M')
>>> period.month
1
"""
base = self._dtype._dtype_code
return pmonth(self.ordinal, base)
Expand Down Expand Up @@ -2301,6 +2313,12 @@ cdef class _Period(PeriodMixin):
def quarter(self) -> int:
"""
Return the quarter this Period falls on.

Examples
--------
>>> period = pd.Period('2022-04', 'M')
>>> period.quarter
2
"""
base = self._dtype._dtype_code
return pquarter(self.ordinal, base)
Expand Down Expand Up @@ -2409,6 +2427,16 @@ cdef class _Period(PeriodMixin):
def is_leap_year(self) -> bool:
"""
Return True if the period's year is in a leap year.

Examples
--------
>>> period = pd.Period('2022-01', 'M')
>>> period.is_leap_year
False

>>> period = pd.Period('2020-01', 'M')
>>> period.is_leap_year
True
"""
return bool(is_leapyear(self.year))

Expand All @@ -2428,6 +2456,11 @@ cdef class _Period(PeriodMixin):
def freqstr(self) -> str:
"""
Return a string representation of the frequency.

Examples
--------
>>> pd.Period('2020-01', 'D').freqstr
'D'
"""
return self._dtype._freqstr

Expand Down