doc: update cbrt() doc comment

korbexmachina · Mar 26, 2024 · d58a6c6 · d58a6c6
1 parent 09c0dcd
commit d58a6c6
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/gcalc.gleam b/src/gcalc.gleam
@@ -131,6 +131,8 @@ fn pow10_iter(n: Float, accumulator: Float) -> Float {
 // Cube Root Functions --------------------------------------------------------
 
 /// Returns a result containing the cube root of the argument
+///
+/// Note: This function only supports non-negative values
 pub fn cbrt(n: Float) -> Result(Float, MathError) {
   case n <. 0.0 {
     True -> Error(ValueOutOfRange)