[docs] Add warning about using user button to docs (NFC) (#6129)

2026-06-22 01:11:42 +00:00 · 2024-01-01 11:53:21 -08:00
parent ec3cb3dcba
commit 7d3e4ddba9
4 changed files with 16 additions and 0 deletions
--- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java
+++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/RobotController.java
@@ -79,6 +79,10 @@ public final class RobotController {
  /**
   * Get the state of the "USER" button on the roboRIO.
   *
+   * <p>Warning: the User Button is used to stop user programs from automatically loading if it is
+   * held for more then 5 seconds. Because of this, it's not recommended to be used by teams for any
+   * other purpose.
+   *
   * @return true if the button is currently pressed down
   */
  public static boolean getUserButton() {