[wpiunits] Clarify return conditions for isEquivalent (NFC) (#6727)

wpilibsuite · Jun 9, 2024 · ae6954c · ae6954c
1 parent a087544
commit ae6954c
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/wpiunits/src/main/java/edu/wpi/first/units/Measure.java b/wpiunits/src/main/java/edu/wpi/first/units/Measure.java
@@ -299,7 +299,7 @@ default boolean isNear(Measure<U> other, Measure<U> tolerance) {
    * @return true if this measure is equivalent, false otherwise
    */
   default boolean isEquivalent(Measure<?> other) {
-    // Check for disjoint units that aren't compatible
+    // Return false for disjoint units that aren't compatible
     return this.unit().getBaseUnit().equals(other.unit().getBaseUnit())
         && Math.abs(baseUnitMagnitude() - other.baseUnitMagnitude()) <= EQUIVALENCE_THRESHOLD;
   }