From 3e8a8f8ae758eb33026d1633ee9c95d10131c03b Mon Sep 17 00:00:00 2001 From: inoas Date: Mon, 10 Oct 2022 11:58:17 +0200 Subject: docblock, changelog --- src/gleam/int.gleam | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'src') 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 /// -- cgit v1.2.3