diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 3b1af77e5f70e..b30a07d20105e 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -79,7 +79,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.api.typing.SeriesGroupBy.plot PR02" \ -i "pandas.api.typing.Resampler.quantile PR01,PR07" \ -i "pandas.arrays.NumpyExtensionArray GL08" \ - -i "pandas.tseries.offsets.BDay PR02,SA01" \ + -i "pandas.tseries.offsets.BDay PR02" \ -i "pandas.tseries.offsets.BHalfYearBegin.is_on_offset GL08" \ -i "pandas.tseries.offsets.BHalfYearBegin.n GL08" \ -i "pandas.tseries.offsets.BHalfYearBegin.normalize GL08" \ @@ -108,7 +108,7 @@ 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 PR02" \ -i "pandas.tseries.offsets.BusinessDay.calendar GL08" \ -i "pandas.tseries.offsets.BusinessDay.holidays GL08" \ -i "pandas.tseries.offsets.BusinessDay.is_on_offset GL08" \ diff --git a/pandas/_libs/tslibs/offsets.pyx b/pandas/_libs/tslibs/offsets.pyx index ad3fb72d31559..5589427bda02f 100644 --- a/pandas/_libs/tslibs/offsets.pyx +++ b/pandas/_libs/tslibs/offsets.pyx @@ -1899,6 +1899,9 @@ cdef class BusinessDay(BusinessMixin): """ DateOffset subclass representing possibly n business days. + This offset is commonly used in financial and business contexts where weekends + and holidays are excluded from date calculations. + Parameters ---------- n : int, default 1 @@ -1908,6 +1911,16 @@ cdef class BusinessDay(BusinessMixin): offset : timedelta, default timedelta(0) Time offset to apply. + Returns + ------- + BusinessDay + A business day offset instance. + + See Also + -------- + CustomBusinessDay : A business day offset with custom holidays and weekmask. + DateOffset : The base class for all time-based offsets. + Examples -------- You can use the parameter ``n`` to represent a shift of n business days.