Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-24 01:31:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Remove redundant "quick turn" docs for curvature drive (NFC) (#3674)

Browse Source 
The parameter docs for allowTurnInPlace say the same thing, and it's no
longer called "quick turn".
This commit is contained in:
Tyler Veness
2021-10-26 23:37:11 -07:00
committed by GitHub
parent 57301a7f9c
commit aa0b49228d
2 changed files with 4 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
wpilibj/src/main/java/edu/wpi/first/wpilibj/drive/DifferentialDrive.java
View File

@@ -185,9 +185,7 @@ public class DifferentialDrive extends RobotDriveBase implements Sendable, AutoC
* Curvature drive method for differential drive platform.
*
* <p>The rotation argument controls the curvature of the robot's path rather than its rate of
* heading change. This makes the robot more controllable at high speeds. Also handles the robot's
* quick turn functionality - "quick turn" overrides constant-curvature turning for turn-in-place
* maneuvers.
* heading change. This makes the robot more controllable at high speeds.
*
* @param xSpeed The robot's speed along the X axis [-1.0..1.0]. Forward is positive.
* @param zRotation The robot's rotation rate around the Z axis [-1.0..1.0]. Clockwise is
@@ -312,9 +310,7 @@ public class DifferentialDrive extends RobotDriveBase implements Sendable, AutoC
* Curvature drive inverse kinematics for differential drive platform.
*
* <p>The rotation argument controls the curvature of the robot's path rather than its rate of
* heading change. This makes the robot more controllable at high speeds. Also handles the robot's
* quick turn functionality - "quick turn" overrides constant-curvature turning for turn-in-place
* maneuvers.
* heading change. This makes the robot more controllable at high speeds.
*
* @param xSpeed The robot's speed along the X axis [-1.0..1.0]. Forward is positive.
* @param zRotation The robot's rotation rate around the Z axis [-1.0..1.0]. Clockwise is