use assert in examples

Author: giacomocavalieri

src/gleam/bit_array.gleam

@@ -33,8 +33,8 @@ pub fn pad_to_bytes(x: BitArray) -> BitArray
 /// ## Examples
 ///
 /// ```gleam
-/// append(to: from_string("butter"), suffix: from_string("fly"))
-/// // -> from_string("butterfly")
+/// assert append(to: from_string("butter"), suffix: from_string("fly"))
+///   == from_string("butterfly")
 /// ```
 ///
 pub fn append(to first: BitArray, suffix second: BitArray) -> BitArray {
@@ -100,8 +100,8 @@ fn unsafe_to_string(a: BitArray) -> String
 /// ## Examples
 ///
 /// ```gleam
-/// concat([from_string("butter"), from_string("fly")])
-/// // -> from_string("butterfly")
+/// assert concat([from_string("butter"), from_string("fly")])
+///   == from_string("butterfly")
 /// ```
 ///
 @external(erlang, "gleam_stdlib", "bit_array_concat")
@@ -177,11 +177,11 @@ pub fn base16_decode(input: String) -> Result(BitArray, Nil)
 /// ## Examples
 ///
 /// ```gleam
-/// inspect(<<0, 20, 0x20, 255>>)
-/// // -> "<<0, 20, 32, 255>>"
+/// assert inspect(<<0, 20, 0x20, 255>>) == "<<0, 20, 32, 255>>"
+/// ```
 ///
-/// inspect(<<100, 5:3>>)
-/// // -> "<<100, 5:size(3)>>"
+/// ```gleam
+/// assert inspect(<<100, 5:3>>) == "<<100, 5:size(3)>>"
 /// ```
 ///
 pub fn inspect(input: BitArray) -> String {
@@ -219,14 +219,15 @@ fn inspect_loop(input: BitArray, accumulator: String) -> String {
 /// ## Examples
 ///
 /// ```gleam
-/// compare(<<1>>, <<2>>)
-/// // -> Lt
+/// assert compare(<<1>>, <<2>>) == Lt
+/// ```
 ///
-/// compare(<<"AB":utf8>>, <<"AA":utf8>>)
-/// // -> Gt
+/// ```gleam
+/// assert compare(<<"AB":utf8>>, <<"AA":utf8>>) == Gt
+/// ```
 ///
-/// compare(<<1, 2:size(2)>>, with: <<1, 2:size(2)>>)
-/// // -> Eq
+/// ```gleam
+/// assert compare(<<1, 2:size(2)>>, with: <<1, 2:size(2)>>) == Eq
 /// ```
 ///
 pub fn compare(a: BitArray, with b: BitArray) -> order.Order {
@@ -265,8 +266,7 @@ fn bit_array_to_int_and_size(a: BitArray) -> #(Int, Int)
 /// ## Examples
 ///
 /// ```gleam
-/// starts_with(<<1, 2, 3, 4>>, <<1, 2>>)
-/// // -> True
+/// assert starts_with(<<1, 2, 3, 4>>, <<1, 2>>)
 /// ```
 ///
 @external(javascript, "../gleam_stdlib.mjs", "bit_array_starts_with")

src/gleam/bool.gleam

@@ -14,18 +14,19 @@
 /// ## Examples
 ///
 /// ```gleam
-/// and(True, True)
-/// // -> True
+/// assert and(True, True)
 /// ```
 ///
 /// ```gleam
-/// and(False, True)
-/// // -> False
+/// assert !and(False, True)
 /// ```
 ///
 /// ```gleam
-/// False |> and(True)
-/// // -> False
+/// assert !and(False, True)
+/// ```
+///
+/// ```gleam
+/// assert !and(False, False)
 /// ```
 ///
 pub fn and(a: Bool, b: Bool) -> Bool {
@@ -40,18 +41,19 @@ pub fn and(a: Bool, b: Bool) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// or(True, True)
-/// // -> True
+/// assert or(True, True)
+/// ```
+///
+/// ```gleam
+/// assert or(False, True)
 /// ```
 ///
 /// ```gleam
-/// or(False, True)
-/// // -> True
+/// assert or(False, True)
 /// ```
 ///
 /// ```gleam
-/// False |> or(True)
-/// // -> True
+/// assert !or(False, False)
 /// ```
 ///
 pub fn or(a: Bool, b: Bool) -> Bool {
@@ -65,13 +67,11 @@ pub fn or(a: Bool, b: Bool) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// negate(True)
-/// // -> False
+/// assert !negate(True)
 /// ```
 ///
 /// ```gleam
-/// negate(False)
-/// // -> True
+/// assert negate(False)
 /// ```
 ///
 pub fn negate(bool: Bool) -> Bool {
@@ -83,23 +83,19 @@ pub fn negate(bool: Bool) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// nor(False, False)
-/// // -> True
+/// assert nor(False, False)
 /// ```
 ///
 /// ```gleam
-/// nor(False, True)
-/// // -> False
+/// assert !nor(False, True)
 /// ```
 ///
 /// ```gleam
-/// nor(True, False)
-/// // -> False
+/// assert !nor(True, False)
 /// ```
 ///
 /// ```gleam
-/// nor(True, True)
-/// // -> False
+/// assert !nor(True, True)
 /// ```
 ///
 pub fn nor(a: Bool, b: Bool) -> Bool {
@@ -111,23 +107,19 @@ pub fn nor(a: Bool, b: Bool) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// nand(False, False)
-/// // -> True
+/// assert nand(False, False)
 /// ```
 ///
 /// ```gleam
-/// nand(False, True)
-/// // -> True
+/// assert nand(False, True)
 /// ```
 ///
 /// ```gleam
-/// nand(True, False)
-/// // -> True
+/// assert nand(True, False)
 /// ```
 ///
 /// ```gleam
-/// nand(True, True)
-/// // -> False
+/// assert !nand(True, True)
 /// ```
 ///
 pub fn nand(a: Bool, b: Bool) -> Bool {
@@ -139,23 +131,19 @@ pub fn nand(a: Bool, b: Bool) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// exclusive_or(False, False)
-/// // -> False
+/// assert !exclusive_or(False, False)
 /// ```
 ///
 /// ```gleam
-/// exclusive_or(False, True)
-/// // -> True
+/// assert exclusive_or(False, True)
 /// ```
 ///
 /// ```gleam
-/// exclusive_or(True, False)
-/// // -> True
+/// assert exclusive_or(True, False)
 /// ```
 ///
 /// ```gleam
-/// exclusive_or(True, True)
-/// // -> False
+/// assert !exclusive_or(True, True)
 /// ```
 ///
 pub fn exclusive_or(a: Bool, b: Bool) -> Bool {
@@ -167,23 +155,19 @@ pub fn exclusive_or(a: Bool, b: Bool) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// exclusive_nor(False, False)
-/// // -> True
+/// assert exclusive_nor(False, False)
 /// ```
 ///
 /// ```gleam
-/// exclusive_nor(False, True)
-/// // -> False
+/// assert !exclusive_nor(False, True)
 /// ```
 ///
 /// ```gleam
-/// exclusive_nor(True, False)
-/// // -> False
+/// assert !exclusive_nor(True, False)
 /// ```
 ///
 /// ```gleam
-/// exclusive_nor(True, True)
-/// // -> True
+/// assert exclusive_nor(True, True)
 /// ```
 ///
 pub fn exclusive_nor(a: Bool, b: Bool) -> Bool {
@@ -195,13 +179,11 @@ pub fn exclusive_nor(a: Bool, b: Bool) -> Bool {
 /// ## Examples
 ///
 /// ```gleam
-/// to_string(True)
-/// // -> "True"
+/// assert to_string(True) == "True"
 /// ```
 ///
 /// ```gleam
-/// to_string(False)
-/// // -> "False"
+/// assert to_string(False) == "False"
 /// ```
 ///
 pub fn to_string(bool: Bool) -> String {