aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGiacomo Cavalieri <giacomo.cavalieri@icloud.com>2023-05-23 22:55:55 +0200
committerLouis Pilfold <louis@lpil.uk>2023-05-24 10:44:50 +0100
commit785398d47294caeb74aaf5030c12b880e324dc5a (patch)
tree55cf530a010a0ded6fb415b7d53b1753aeae06ef
parentee76a85e29333dc65865fb0197306fa0aedb54f7 (diff)
downloadgleam_stdlib-785398d47294caeb74aaf5030c12b880e324dc5a.tar.gz
gleam_stdlib-785398d47294caeb74aaf5030c12b880e324dc5a.zip
Update examples to use `let assert` syntax instead of `assert`
-rw-r--r--src/gleam/iterator.gleam4
-rw-r--r--src/gleam/regex.gleam10
-rw-r--r--src/gleam/string.gleam2
-rw-r--r--src/gleam/uri.gleam2
4 files changed, 9 insertions, 9 deletions
diff --git a/src/gleam/iterator.gleam b/src/gleam/iterator.gleam
index 127be34..b583d01 100644
--- a/src/gleam/iterator.gleam
+++ b/src/gleam/iterator.gleam
@@ -237,7 +237,7 @@ pub fn to_list(iterator: Iterator(element)) -> List(element) {
|> list.reverse
}
-/// Eagerly accesses the first value of an interator, returning a `Next`
+/// Eagerly accesses the first value of an iterator, returning a `Next`
/// that contains the first value and the rest of the iterator.
///
/// If called on an empty iterator, `Done` is returned.
@@ -245,7 +245,7 @@ pub fn to_list(iterator: Iterator(element)) -> List(element) {
/// ## Examples
///
/// ```gleam
-/// > assert Next(head, tail) = [1, 2, 3, 4]
+/// > let assert Next(head, tail) = [1, 2, 3, 4]
/// > |> from_list
/// > |> step
/// > head
diff --git a/src/gleam/regex.gleam b/src/gleam/regex.gleam
index 71ac994..f1161cc 100644
--- a/src/gleam/regex.gleam
+++ b/src/gleam/regex.gleam
@@ -40,14 +40,14 @@ pub type Options {
///
/// ```gleam
/// > let options = Options(case_insensitive: False, multi_line: True)
-/// > assert Ok(re) = compile("^[0-9]", with: options)
+/// > let assert Ok(re) = compile("^[0-9]", with: options)
/// > check(re, "abc\n123")
/// True
/// ```
///
/// ```gleam
/// > let options = Options(case_insensitive: True, multi_line: False)
-/// > assert Ok(re) = compile("[A-Z]", with: options)
+/// > let assert Ok(re) = compile("[A-Z]", with: options)
/// > check(re, "abc123")
/// True
/// ```
@@ -74,7 +74,7 @@ if javascript {
/// ## Examples
///
/// ```gleam
-/// > assert Ok(re) = from_string("[0-9]")
+/// > let assert Ok(re) = from_string("[0-9]")
/// > check(re, "abc123")
/// True
/// ```
@@ -103,7 +103,7 @@ pub fn from_string(pattern: String) -> Result(Regex, CompileError) {
/// ## Examples
///
/// ```gleam
-/// > assert Ok(re) = from_string("^f.o.?")
+/// > let assert Ok(re) = from_string("^f.o.?")
/// > check(with: re, content: "foo")
/// True
/// ```
@@ -132,7 +132,7 @@ if javascript {
/// ## Examples
///
/// ```gleam
-/// > assert Ok(re) = from_string(" *, *")
+/// > let assert Ok(re) = from_string(" *, *")
/// > split(with: re, content: "foo,32, 4, 9 ,0")
/// ["foo", "32", "4", "9", "0"]
/// ```
diff --git a/src/gleam/string.gleam b/src/gleam/string.gleam
index e12983d..cf7d48d 100644
--- a/src/gleam/string.gleam
+++ b/src/gleam/string.gleam
@@ -840,7 +840,7 @@ if javascript {
///
/// ```gleam
/// > {
-/// > assert #(Ok(a), Ok(b), Ok(c)) = #(
+/// > let assert #(Ok(a), Ok(b), Ok(c)) = #(
/// > utf_codepoint(97),
/// > utf_codepoint(98),
/// > utf_codepoint(99),
diff --git a/src/gleam/uri.gleam b/src/gleam/uri.gleam
index 1557b5a..3fdfc6d 100644
--- a/src/gleam/uri.gleam
+++ b/src/gleam/uri.gleam
@@ -381,7 +381,7 @@ pub fn to_string(uri: Uri) -> String {
/// ## Examples
///
/// ```gleam
-/// > assert Ok(uri) = parse("http://example.com/path?foo#bar")
+/// > let assert Ok(uri) = parse("http://example.com/path?foo#bar")
/// > origin(uri)
/// Ok("http://example.com")
/// ```