Skip to content

Commit b0ef2a5

Browse files
Clarify duration arg description in logging macros (#359) (#361)
The expectation that the `duration` argument to the logging macros will be an integral value in milliseconds is not explicit at all, and as such the documentation for this argument should be clarified. Prior to this change, this information could only be found inside `RCUTILS_LOG_CONDITION_THROTTLE_BEFORE`, which is inconvenient. Signed-off-by: Abrar Rahman Protyasha <aprotyas@u.rochester.edu> (cherry picked from commit 8da2aac) Co-authored-by: Abrar Rahman Protyasha <aprotyas@u.rochester.edu>
1 parent 7c1e97e commit b0ef2a5

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

rcutils/logging.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
throttle_params = OrderedDict((
5757
('get_time_point_value', 'Function that returns rcutils_ret_t and expects a '
5858
'rcutils_time_point_value_t pointer.'),
59-
('duration', 'The duration of the throttle interval'),
59+
('duration', 'The duration of the throttle interval as an integral value in milliseconds.'),
6060
))
6161
throttle_args = {
6262
'condition_before': 'RCUTILS_LOG_CONDITION_THROTTLE_BEFORE(get_time_point_value, duration)',

0 commit comments

Comments
 (0)