diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/gleam/int.gleam | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/gleam/int.gleam b/src/gleam/int.gleam index 6a30e60..295381c 100644 --- a/src/gleam/int.gleam +++ b/src/gleam/int.gleam @@ -527,7 +527,8 @@ pub fn divide(a: Int, by b: Int) -> Result(Int, Nil) { /// If you want to perform truncated integer division (rounding towards zero), /// use `int.divide()` or the `/` operator instead. /// -/// Returns division of the inputs as a `Result`. +/// Returns division of the inputs as a `Result`: If the given divisor equals +/// `0`, this function returns an `Error`. /// /// ## Examples /// |