From cf061c11709adcbe442ba87c2514ef9feecf9991 Mon Sep 17 00:00:00 2001
From: "Keenan D. Buckley" <keenandbuckley@protonmail.com>
Date: Wed, 12 Feb 2020 20:33:16 -0700
Subject: [PATCH] Update DriveWithJoystickUsingDeadAssist Documentation

---
 .../commands/DriveWithJoystickUsingDeadAssistPID.java     | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/main/java/frc4388/robot/commands/DriveWithJoystickUsingDeadAssistPID.java b/src/main/java/frc4388/robot/commands/DriveWithJoystickUsingDeadAssistPID.java
index 3d338fb..11f3261 100644
--- a/src/main/java/frc4388/robot/commands/DriveWithJoystickUsingDeadAssistPID.java
+++ b/src/main/java/frc4388/robot/commands/DriveWithJoystickUsingDeadAssistPID.java
@@ -21,7 +21,13 @@ public class DriveWithJoystickUsingDeadAssistPID extends CommandBase {
   boolean isAuxPIDEnabled = false;
 
   /**
-   * Creates a new DriveWithJoystickUsingDeadAssist.
+   * Creates a new DriveWithJoystickUsingDeadAssistPID to control the drivetrain with an Xbox controller.
+   * Applies a curved ramp to the input from the controllers to make the robot less "touchy".
+   * Also uses PIDs to keep the robot on course when given a "dead" or 0 input.
+   * @param subsystem pass the Drive subsystem from {@link frc4388.robot.RobotContainer#RobotContainer() RobotContainer}
+   * @param controller pass the Driver {@link frc4388.utility.controller.IHandController#getClass() IHandController} using the
+   * {@link frc4388.robot.RobotContainer#getDriverJoystick() getDriverJoystick()} method in
+   * {@link frc4388.robot.RobotContainer#RobotContainer() RobotContainer}
    */
   public DriveWithJoystickUsingDeadAssistPID(Drive subsystem, IHandController controller) {
     // Use addRequirements() here to declare subsystem dependencies.