Add a warning to schedule docs (#70)

robotpy · Feb 3, 2025 · 196fde6 · 196fde6
1 parent e3c8a9e
commit 196fde6
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/commands2/commandscheduler.py b/commands2/commandscheduler.py
@@ -177,6 +177,9 @@ def schedule(self, *commands: Command) -> None:
         using those requirements have been scheduled as interruptible. If this is the case, they will
         be interrupted and the command will be scheduled.
 
+        WARNING: using this function directly can often lead to unexpected behavior and should be
+        avoided. Instead Triggers should be used to schedule Commands.
+
         :param commands: the commands to schedule.
         """
         for command in commands: