guard_condition docstring

Signed-off-by: elian-WSL22H <elian.neppel@posteo.eu>

rclpy/rclpy/guard_condition.py

@@ -19,6 +19,10 @@
 class GuardCondition:
 
     def __init__(self, callback, callback_group, context=None):
+        """
+        .. warning:: Users should not create a guard condition with this constructor, instead they
+           should call :meth:`.Node.create_guard_condition`.
+        """
         self._context = get_default_context() if context is None else context
         with self._context.handle:
             self.__gc = _rclpy.GuardCondition(self._context.handle)
@@ -38,4 +42,8 @@ def handle(self):
         return self.__gc
 
     def destroy(self):
+        """
+        .. warning:: Users should not destroy a guard condition with this method, instead they should
+           call :meth:`.Node.destroy_guard_condition`.
+        """
         self.handle.destroy_when_not_in_use()

rclpy/rclpy/node.py

@@ -1780,7 +1780,10 @@ def create_guard_condition(
         callback: Callable,
         callback_group: Optional[CallbackGroup] = None
     ) -> GuardCondition:
-        """Create a new guard condition."""
+        """Create a new guard condition.
+
+        .. warning:: Users should call :meth:`.Node.destroy_guard_condition` to destroy the GuardCondition object.
+        """
         if callback_group is None:
             callback_group = self.default_callback_group
         guard = GuardCondition(callback, callback_group, context=self.context)