Skip to content

Commit 4c6d9eb

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.DatetimeIndex.snap (#58477)
* DOC: add PR01,RT03 for pandas.DatetimeIndex.snap * DOC: remove pandas.DatetimeIndex.snap
1 parent d038da8 commit 4c6d9eb

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9898
-i "pandas.DataFrame.swaplevel SA01" \
9999
-i "pandas.DataFrame.to_markdown SA01" \
100100
-i "pandas.DataFrame.var PR01,RT03,SA01" \
101-
-i "pandas.DatetimeIndex.snap PR01,RT03" \
102101
-i "pandas.Grouper PR02" \
103102
-i "pandas.Index PR07" \
104103
-i "pandas.Index.append PR07,RT03,SA01" \

pandas/core/indexes/datetimes.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -451,9 +451,17 @@ def snap(self, freq: Frequency = "S") -> DatetimeIndex:
451451
"""
452452
Snap time stamps to nearest occurring frequency.
453453
454+
Parameters
455+
----------
456+
freq : str, Timedelta, datetime.timedelta, or DateOffset, default 'S'
457+
Frequency strings can have multiples, e.g. '5h'. See
458+
:ref:`here <timeseries.offset_aliases>` for a list of
459+
frequency aliases.
460+
454461
Returns
455462
-------
456463
DatetimeIndex
464+
Time stamps to nearest occurring `freq`.
457465
458466
See Also
459467
--------

0 commit comments

Comments
 (0)