Skip to content

DOC: Validate docstrings for tseries.offsets.BusinessDay #62078

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

doughillyer
Copy link

  • closes DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063 (partially)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

This PR validates and fixes the docstrings for pandas.tseries.offsets.BusinessDay and several of its properties to conform with the NumPy docstring standard.

The following changes were made:

  • Moved the Parameters section from the BusinessDay class docstring to the __init__ method of the parent BusinessMixin class to resolve a PR02 validation error. This aligns with the NumPy docstring standard.
  • Added fully-featured docstrings (including See Also and Examples) to the .calendar, .holidays, and .weekmask properties to resolve GL08 errors.
  • Removed the now-passing methods from the ignore list in ci/code_checks.sh.

@doughillyer doughillyer requested a review from mroeschke as a code owner August 9, 2025 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Enforce Numpy Docstring Validation (Parent Issue)
1 participant