update docs

rzblue · Sep 15, 2023 · f8b7931 · f8b7931
1 parent dac965d
commit f8b7931
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Commands.java b/wpilibNewCommands/src/main/java/edu/wpi/first/wpilibj2/command/Commands.java
@@ -152,8 +152,8 @@ public static Command select(Map<Object, Command> commands, Supplier<Object> sel
   }
 
   /**
-   * Constructs a command that schedules the supplied command when initialized, and ends when it is
-   * no longer scheduled.
+   * Constructs a command that schedules the command returned from the supplier when initialized, and ends when it is
+   * no longer scheduled. The supplier is called when the command is initialized.
    *
    * @param supplier the command supplier
    * @return the command

diff --git a/wpilibNewCommands/src/main/native/include/frc2/command/Commands.h b/wpilibNewCommands/src/main/native/include/frc2/command/Commands.h
@@ -188,17 +188,19 @@ CommandPtr Select(std::function<Key()> selector,
 }
 
 /**
- * Constructs a command that schedules the supplied command when initialized,
- * and ends when it is no longer scheduled
+ * Constructs a command that schedules the command returned from the supplier
+ * when initialized, and ends when it is no longer scheduled. The supplier is
+ * called when the command is initialized.
  *
  * @param supplier the command supplier
  */
 [[nodiscard]]
 CommandPtr DeferredProxy(wpi::unique_function<Command*()> supplier);
 
 /**
- * Constructs a command that schedules the supplied command when initialized,
- * and ends when it is no longer scheduled
+ * Constructs a command that schedules the command returned from the supplier
+ * when initialized, and ends when it is no longer scheduled. The supplier is
+ * called when the command is initialized.
  *
  * @param supplier the command supplier
  */