Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.DatetimeIndex.snap #58477

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

Merged
merged 4 commits into from
Apr 29, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.DatetimeIndex.snap #58477

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
bd4e9ce
DOC: add PR01,RT03 for pandas.DatetimeIndex.snap
tuhinsharma121 Apr 29, 2024
c0b63f6
DOC: remove pandas.DatetimeIndex.snap
tuhinsharma121 Apr 29, 2024
3ad0dc1
DOC: resolved merge conflicts
tuhinsharma121 Apr 29, 2024
3f92063
Merge branch 'main' into numpy-docstring-datetimeindex-snap
tuhinsharma121 Apr 29, 2024
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
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand Down
8 changes: 8 additions & 0 deletions pandas/core/indexes/datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <timeseries.offset_aliases>` for a list of
frequency aliases.

Returns
-------
DatetimeIndex
Time stamps to nearest occurring `freq`.

See Also
--------
Expand Down