diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 58ecae66e1bcc..ce53c9fca60e0 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -98,7 +98,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.DataFrame.swaplevel SA01" \ -i "pandas.DataFrame.to_markdown SA01" \ -i "pandas.DataFrame.var PR01,RT03,SA01" \ - -i "pandas.DatetimeIndex.snap PR01,RT03" \ -i "pandas.Grouper PR02" \ -i "pandas.Index PR07" \ -i "pandas.Index.append PR07,RT03,SA01" \ diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index 742f66aa80728..78f04f57029b1 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -451,9 +451,17 @@ def snap(self, freq: Frequency = "S") -> DatetimeIndex: """ Snap time stamps to nearest occurring frequency. + Parameters + ---------- + freq : str, Timedelta, datetime.timedelta, or DateOffset, default 'S' + Frequency strings can have multiples, e.g. '5h'. See + :ref:`here ` for a list of + frequency aliases. + Returns ------- DatetimeIndex + Time stamps to nearest occurring `freq`. See Also --------