Skip to content

Commit 72db078

Browse files
DOC: change docstring in sync with pandas.Timestamp.round
1 parent 6737b19 commit 72db078

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

pandas/_libs/tslibs/nattype.pyx

+14
Original file line numberDiff line numberDiff line change
@@ -947,6 +947,12 @@ class NaTType(_NaT):
947947
"""
948948
Round the Timestamp to the specified resolution.
949949
950+
This method rounds the given Timestamp down to a specified frequency
951+
level. It is particularly useful in data analysis to normalize timestamps
952+
to regular frequency intervals. For instance, rounding to the nearest
953+
minute, hour, or day can help in time series comparisons or resampling
954+
operations.
955+
950956
Parameters
951957
----------
952958
freq : str
@@ -981,6 +987,14 @@ timedelta}, default 'raise'
981987
------
982988
ValueError if the freq cannot be converted
983989
990+
See Also
991+
--------
992+
datetime.round : Similar behavior in native Python datetime module.
993+
Timestamp.floor : Round the Timestamp downward to the nearest multiple
994+
of the specified frequency.
995+
Timestamp.ceil : Round the Timestamp upward to the nearest multiple of
996+
the specified frequency.
997+
984998
Notes
985999
-----
9861000
If the Timestamp has a timezone, rounding will take place relative to the

0 commit comments

Comments
 (0)