Skip to content
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

DOC: fix PR02,SA01,ES01 for pandas.tseries.offsets.BDay and pandas.tseries.offsets.BusinessDay #60807

Closed
wants to merge 2 commits into from
+13 −3
Closed

DOC: fix PR02,SA01,ES01 for pandas.tseries.offsets.BDay and pandas.tseries.offsets.BusinessDay #60807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8b4481
DOC: fix PR02,SA01,ES01 for pandas.tseries.offsets.BDay and pandas.ts…
tuhinsharma121 Jan 28, 2025
8af4076
DOC: fix PR02,SA01,ES01 for pandas.tseries.offsets.BDay and pandas.ts…
tuhinsharma121 Jan 28, 2025
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
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-i "pandas.core.resample.Resampler.quantile PR01,PR07" \
-i "pandas.core.resample.Resampler.transform PR01,RT03,SA01" \
-i "pandas.tseries.offsets.BDay PR02,SA01" \
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.n GL08" \
-i "pandas.tseries.offsets.BQuarterBegin.normalize GL08" \
Expand All @@ -102,7 +101,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.tseries.offsets.BYearEnd.month GL08" \
-i "pandas.tseries.offsets.BYearEnd.n GL08" \
-i "pandas.tseries.offsets.BYearEnd.normalize GL08" \
-i "pandas.tseries.offsets.BusinessDay PR02,SA01" \
-i "pandas.tseries.offsets.BusinessDay.calendar GL08" \
-i "pandas.tseries.offsets.BusinessDay.holidays GL08" \
-i "pandas.tseries.offsets.BusinessDay.is_on_offset GL08" \
Expand Down
14 changes: 13 additions & 1 deletion pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1838,7 +1838,12 @@ cdef class BusinessDay(BusinessMixin):
"""
DateOffset subclass representing possibly n business days.

Parameters
This class is used to perform date arithmetic involving business days.
Business days are defined by default as weekdays (Monday to Friday),
excluding weekends, but can be customized to exclude or include specific
holidays by combining with a ``CustomBusinessDay``.

Attributes
----------
n : int, default 1
The number of days represented.
Expand All @@ -1847,6 +1852,13 @@ cdef class BusinessDay(BusinessMixin):
offset : timedelta, default timedelta(0)
Time offset to apply.

See Also
--------
tseries.offsets.CustomBusinessDay : A customizable version of
`BusinessDay` that allows for the inclusion of holidays and other
non-standard business day definitions.
date_range : Generate a range of dates with a specific frequency.

Examples
--------
You can use the parameter ``n`` to represent a shift of n business days.
Expand Down
Loading