Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-20 00:51:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpimath] Improve documentation for SwerveModulePosition::operator- (#5468)

Browse Source
This commit is contained in:
Joseph Eng
2023-07-24 22:46:59 -07:00
committed by GitHub
parent b8cdf97621
commit 2ba8fbb6f4
3 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
wpimath/src/main/java/edu/wpi/first/math/kinematics/SwerveModulePosition.java
View File

@@ -76,7 +76,8 @@ public class SwerveModulePosition
/**
* Calculates the difference between two swerve module positions. The difference has a length
* equal to the difference in lengths and an angle equal to the ending angle (this module
* position's angle).
* position's angle). This is suitable for representing a module's motion between two timesteps,
* because the final angle describes the direction the module moved.
*
* @param other The swerve module position to subtract.
* @return The difference.

2
wpimath/src/main/java/edu/wpi/first/math/kinematics/WheelPositions.java
View File

@@ -15,7 +15,7 @@ public interface WheelPositions<T extends WheelPositions<T>> extends Interpolata
T copy();
/**
* Returns the difference with another set of wheel positions.
* Returns a representation of how the wheels moved from other to this.
*
* @param other The other instance to compare to.
* @return The representation of how the wheels moved from other to this.