Skip to content

[DOC] Improved docstring offset class BusinessDay #62861

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

Closed
wants to merge 4 commits into from
Closed

[DOC] Improved docstring offset class BusinessDay #62861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
be8f61b
Improved docstring offset class BusinessDay
Oct 25, 2025
ad2945d
removed whitespace in docstring
Oct 26, 2025
b405767
removed fixed docstring from CI code checks
Oct 26, 2025
65ae456
reverted deletion CI code_check PR02 on cython class
Oct 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
4 changes: 2 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand Down Expand Up @@ -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" \
Expand Down
13 changes: 13 additions & 0 deletions pandas/_libs/tslibs/offsets.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Loading