DOC: Update type of name argument in bdate_range to Hashable #63383
+3
−3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
nameinbdate_rangeshould beHashable#63378doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.AGENTS.md.Description
Updates the docstring for the
nameparameter inpandas.bdate_range(located inpandas/core/indexes/datetimes.py).EDIT: Also updates the docstring for the
nameparameter fordate_rangeandtimedelta_range.The type was previously documented as
str, but the implementation supports anyHashableobject (consistent with other index constructors). Updated toname : Hashable, default None.Validation
Ran the docstring validation script locally:
python scripts/validate_docstrings.py pandas.bdate_range