From 34fed79cf8839f80de808177c9d6ebed4b2497a4 Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Sat, 18 May 2024 10:55:02 +0530 Subject: [PATCH] DOC: add PR02,SA01 for pandas.tseries.offsets.BusinessDay and pandas.tseries.offsets.BDay --- ci/code_checks.sh | 2 -- pandas/_libs/tslibs/offsets.pyx | 6 +++++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 180083dbbb742..5620c15cbc233 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -522,7 +522,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.testing.assert_index_equal PR07,SA01" \ -i "pandas.testing.assert_series_equal PR07,SA01" \ -i "pandas.timedelta_range SA01" \ - -i "pandas.tseries.offsets.BDay PR02,SA01" \ -i "pandas.tseries.offsets.BMonthBegin PR02" \ -i "pandas.tseries.offsets.BQuarterBegin PR02" \ -i "pandas.tseries.offsets.BQuarterBegin.freqstr SA01" \ @@ -555,7 +554,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.tseries.offsets.BYearEnd.nanos GL08" \ -i "pandas.tseries.offsets.BYearEnd.normalize GL08" \ -i "pandas.tseries.offsets.BYearEnd.rule_code GL08" \ - -i "pandas.tseries.offsets.BusinessDay PR02,SA01" \ -i "pandas.tseries.offsets.BusinessDay.calendar GL08" \ -i "pandas.tseries.offsets.BusinessDay.freqstr SA01" \ -i "pandas.tseries.offsets.BusinessDay.holidays GL08" \ diff --git a/pandas/_libs/tslibs/offsets.pyx b/pandas/_libs/tslibs/offsets.pyx index 046b4dfc5606b..946c242c998b1 100644 --- a/pandas/_libs/tslibs/offsets.pyx +++ b/pandas/_libs/tslibs/offsets.pyx @@ -1767,7 +1767,7 @@ cdef class BusinessDay(BusinessMixin): """ DateOffset subclass representing possibly n business days. - Parameters + Attributes ---------- n : int, default 1 The number of days represented. @@ -1776,6 +1776,10 @@ cdef class BusinessDay(BusinessMixin): offset : timedelta, default timedelta(0) Time offset to apply. + See Also + -------- + :class:`~pandas.tseries.offsets.DateOffset` : Standard kind of date increment. + Examples -------- You can use the parameter ``n`` to represent a shift of n business days.