rate docstring

Signed-off-by: elian-WSL22H <elian.neppel@posteo.eu>
ros2 · May 18, 2024 · f0bf624 · f0bf624
1 parent a0b5f48
commit f0bf624
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/rclpy/rclpy/node.py b/rclpy/rclpy/node.py
@@ -1798,6 +1798,8 @@ def create_rate(
         """
         Create a Rate object.
 
+        .. warning:: Users should call :meth:`.Node.destroy_rate` to destroy the Rate object.
+
         :param frequency: The frequency the Rate runs at (Hz).
         :param clock: The clock the Rate gets time from.
         """

diff --git a/rclpy/rclpy/timer.py b/rclpy/rclpy/timer.py
@@ -126,6 +126,10 @@ class Rate:
     """A utility for sleeping at a fixed rate."""
 
     def __init__(self, timer: Timer, *, context):
+        """
+        .. warning:: Users should not create a rate with this constructor, instead they
+           should call :meth:`.Node.create_rate`.
+        """
         # Rate is a wrapper around a timer
         self._timer = timer
         self._is_shutdown = False
@@ -147,6 +151,10 @@ def _on_shutdown(self):
         self.destroy()
 
     def destroy(self):
+        """
+        .. warning:: Users should not destroy a rate with this method, instead they should
+           call :meth:`.Node.destroy_rate`.
+        """
         self._is_destroyed = True
         self._event.set()