Add comments explaining large epsilon

JSorngard · Oct 5, 2024 · dbfd9bc · dbfd9bc
1 parent b6b3307
commit dbfd9bc
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -414,6 +414,8 @@ impl LambertW for f32 {
     /// # use approx::assert_abs_diff_eq;
     /// use lambert_w::LambertW;
     ///
+    // The large epsilon is set to let this test pass when the `estrin` feature is enabled,
+    // since the CI may not have fused multiply-add instructions.
     /// assert_abs_diff_eq!((-1e-30).lambert_wm1(), -73.37311, epsilon = 1e-4);
     /// ```
     #[inline]
@@ -453,7 +455,8 @@ impl LambertW for f64 {
     /// ```
     /// # use approx::assert_abs_diff_eq;
     /// use lambert_w::LambertW;
-    ///
+    // The large epsilon is set to let this test pass when the `estrin` feature is enabled,
+    // since the CI may not have fused multiply-add instructions.
     /// assert_abs_diff_eq!((-1e-30).lambert_wm1(), -73.37311031382298, epsilon = 1e-13);
     /// ```
     #[inline]