From f8b793103ed8dc050f5ccf4111bb3cec34b90ec8 Mon Sep 17 00:00:00 2001 From: Ryan Blue Date: Thu, 14 Sep 2023 23:07:51 -0400 Subject: [PATCH] update docs --- .../java/edu/wpi/first/wpilibj2/command/Commands.java | 4 ++-- .../src/main/native/include/frc2/command/Commands.h | 10 ++++++---- 2 files changed, 8 insertions(+), 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 index 69f0b4078b5..1ea8857db3e 100644 --- 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 commands, Supplier 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 index 2099a5c705c..45677e3b416 100644 --- a/wpilibNewCommands/src/main/native/include/frc2/command/Commands.h +++ b/wpilibNewCommands/src/main/native/include/frc2/command/Commands.h @@ -188,8 +188,9 @@ CommandPtr Select(std::function 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 */ @@ -197,8 +198,9 @@ CommandPtr Select(std::function selector, CommandPtr DeferredProxy(wpi::unique_function 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 */