diff options
| -rw-r--r-- | src/gleam/int.gleam | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/src/gleam/int.gleam b/src/gleam/int.gleam index 7623331..44a6de4 100644 --- a/src/gleam/int.gleam +++ b/src/gleam/int.gleam @@ -617,13 +617,12 @@ pub fn divide(dividend: Int, by divisor: Int) -> Result(Int, Nil) { /// Computes the remainder of an integer division of inputs as a `Result`. /// -/// This functions mimicks modulo operation of following languages: -/// C, C#, C++, Go, Java, JavaScript, Kotlin, Nim, PHP, Rust, -/// Scala, Swift, Crystal as well as Erlang's and Elixir's rem operator. -/// /// Returns division of the inputs as a `Result`: If the given divisor equals /// `0`, this function returns an `Error`. /// +/// Most the time you will want to use the `%` operator instead of this +/// function. +/// /// ## Examples /// /// ```gleam @@ -670,12 +669,12 @@ pub fn remainder(dividend: Int, by divisor: Int) -> Result(Int, Nil) { /// Computes the modulo of an integer division of inputs as a `Result`. /// -/// This functions mimicks modulo operation on following languages: -/// Haskell, Lua, Python, Ruby, as well as Elixir's Integer.mod(). -/// /// Returns division of the inputs as a `Result`: If the given divisor equals /// `0`, this function returns an `Error`. /// +/// Most the time you will want to use the `%` operator instead of this +/// function. +/// /// ## Examples /// /// ```gleam |