Add a warning to schedule docs

See wpilibsuite/allwpilib#7073
spacey-sooty · Sep 13, 2024 · f8424b7 · f8424b7
1 parent 125788e
commit f8424b7
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.
+
         :param commands: the commands to schedule.
         """
         for command in commands: