Document current behaviour of difficulty_float

Improve rustdocs on the `Target::difficulty_float` function, specifically the return value if self is zero.
rust-bitcoin · Apr 2, 2024 · c1ba496 · c1ba496
1 parent 3d01146
commit c1ba496
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/bitcoin/src/pow.rs b/bitcoin/src/pow.rs
@@ -245,6 +245,10 @@ impl Target {
     ///
     /// See [`difficulty`] for details.
     ///
+    /// # Returns
+    ///
+    /// Returns [`f64::INFINITY`] if `self` is zero (caused by divide by zero).
+    ///
     /// [`difficulty`]: Target::difficulty
     #[cfg_attr(all(test, mutate), mutate)]
     pub fn difficulty_float(&self) -> f64 { TARGET_MAX_F64 / self.0.to_f64() }