File tree 3 files changed +28
-1
lines changed
3 files changed +28
-1
lines changed Original file line number Diff line number Diff line change @@ -290,7 +290,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
290
290
-i " pandas.Timestamp.quarter SA01" \
291
291
-i " pandas.Timestamp.replace PR07,SA01" \
292
292
-i " pandas.Timestamp.resolution PR02,PR07,SA01" \
293
- -i " pandas.Timestamp.round SA01" \
294
293
-i " pandas.Timestamp.second GL08" \
295
294
-i " pandas.Timestamp.strptime PR01,SA01" \
296
295
-i " pandas.Timestamp.time SA01" \
Original file line number Diff line number Diff line change @@ -970,6 +970,12 @@ class NaTType(_NaT):
970
970
"""
971
971
Round the Timestamp to the specified resolution.
972
972
973
+ This method rounds the given Timestamp down to a specified frequency
974
+ level. It is particularly useful in data analysis to normalize timestamps
975
+ to regular frequency intervals. For instance, rounding to the nearest
976
+ minute, hour, or day can help in time series comparisons or resampling
977
+ operations.
978
+
973
979
Parameters
974
980
----------
975
981
freq : str
@@ -1004,6 +1010,14 @@ timedelta}, default 'raise'
1004
1010
------
1005
1011
ValueError if the freq cannot be converted
1006
1012
1013
+ See Also
1014
+ --------
1015
+ datetime.round : Similar behavior in native Python datetime module.
1016
+ Timestamp.floor : Round the Timestamp downward to the nearest multiple
1017
+ of the specified frequency.
1018
+ Timestamp.ceil : Round the Timestamp upward to the nearest multiple of
1019
+ the specified frequency.
1020
+
1007
1021
Notes
1008
1022
-----
1009
1023
If the Timestamp has a timezone, rounding will take place relative to the
Original file line number Diff line number Diff line change @@ -2038,6 +2038,12 @@ class Timestamp(_Timestamp):
2038
2038
"""
2039
2039
Round the Timestamp to the specified resolution.
2040
2040
2041
+ This method rounds the given Timestamp down to a specified frequency
2042
+ level. It is particularly useful in data analysis to normalize timestamps
2043
+ to regular frequency intervals. For instance, rounding to the nearest
2044
+ minute, hour, or day can help in time series comparisons or resampling
2045
+ operations.
2046
+
2041
2047
Parameters
2042
2048
----------
2043
2049
freq : str
@@ -2072,6 +2078,14 @@ timedelta}, default 'raise'
2072
2078
------
2073
2079
ValueError if the freq cannot be converted
2074
2080
2081
+ See Also
2082
+ --------
2083
+ datetime.round : Similar behavior in native Python datetime module.
2084
+ Timestamp.floor : Round the Timestamp downward to the nearest multiple
2085
+ of the specified frequency.
2086
+ Timestamp.ceil : Round the Timestamp upward to the nearest multiple of
2087
+ the specified frequency.
2088
+
2075
2089
Notes
2076
2090
-----
2077
2091
If the Timestamp has a timezone, rounding will take place relative to the
You can’t perform that action at this time.
0 commit comments