Add a warning to schedule docs

See wpilibsuite/allwpilib#7073
robotpy · Sep 13, 2024 · 6a41954 · 6a41954
1 parent 125788e
commit 6a41954
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/commands2/commandscheduler.py b/commands2/commandscheduler.py
@@ -177,6 +177,8 @@ 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 is often a footgun and should be avoided. Instead Triggers should be used to schedule Commands.
+
         :param commands: the commands to schedule.
         """
         for command in commands: