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

This commit is contained in:
sciencewhiz
2024-01-01 11:53:21 -08:00
committed by GitHub
parent ec3cb3dcba
commit 7d3e4ddba9
4 changed files with 16 additions and 0 deletions

View File

@@ -83,6 +83,10 @@ class RobotController {
/**
* Get the state of the "USER" button on the roboRIO.
*
* @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
*/
static bool GetUserButton();