Skip to content

DOC: add SA01 for pandas.Timestamp.ceil #58762

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

Merged
merged 2 commits into from
May 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.TimedeltaIndex.nanoseconds SA01" \
-i "pandas.TimedeltaIndex.seconds SA01" \
-i "pandas.TimedeltaIndex.to_pytimedelta RT03,SA01" \
-i "pandas.Timestamp.ceil SA01" \
-i "pandas.Timestamp.combine PR01,SA01" \
-i "pandas.Timestamp.ctime SA01" \
-i "pandas.Timestamp.date SA01" \
Expand Down
6 changes: 6 additions & 0 deletions pandas/_libs/tslibs/nattype.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -1216,6 +1216,12 @@ timedelta}, default 'raise'
------
ValueError if the freq cannot be converted.

See Also
--------
Timestamp.floor : Round down a Timestamp to the specified resolution.
Timestamp.round : Round a Timestamp to the specified resolution.
Series.dt.ceil : Ceil the datetime values in a Series.

Notes
-----
If the Timestamp has a timezone, ceiling will take place relative to the
Expand Down
6 changes: 6 additions & 0 deletions pandas/_libs/tslibs/timestamps.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -2285,6 +2285,12 @@ timedelta}, default 'raise'
------
ValueError if the freq cannot be converted.

See Also
--------
Timestamp.floor : Round down a Timestamp to the specified resolution.
Timestamp.round : Round a Timestamp to the specified resolution.
Series.dt.ceil : Ceil the datetime values in a Series.

Notes
-----
If the Timestamp has a timezone, ceiling will take place relative to the
Expand Down