[commands] Add a warning to schedule javadocs

wpilibsuite · Sep 13, 2024 · 7cf1e9c · 7cf1e9c
1 parent 32252f7
commit 7cf1e9c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandScheduler.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/CommandScheduler.java
@@ -180,6 +180,8 @@ private void initCommand(Command command, Set<Subsystem> requirements) {
    * 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 command the command to schedule. If null, no-op.
    */
   private void schedule(Command command) {

diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/CommandScheduler.h b/wpilibNewCommands/src/main/native/include/frc2/command/CommandScheduler.h
@@ -88,6 +88,8 @@ class CommandScheduler final : public wpi::Sendable,
    * 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 command the command to schedule
    */
   void Schedule(const CommandPtr& command);