aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Davies <41101+adz@users.noreply.github.com>2022-07-20 01:02:43 +0930
committerLouis Pilfold <louis@lpil.uk>2022-07-24 13:05:43 +0100
commit0189a71fb7cdf3bc5957be19f02bfa6636479c23 (patch)
tree6afc6fc5ac7c6d07147638a62bc25667f9511a2f
parent3c34bbc56d9dd8a9bf337cd32208863a1761d7bc (diff)
downloadgleam_stdlib-0189a71fb7cdf3bc5957be19f02bfa6636479c23.tar.gz
gleam_stdlib-0189a71fb7cdf3bc5957be19f02bfa6636479c23.zip
Correct dynamic 'optional' docstring
-rw-r--r--src/gleam/dynamic.gleam12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/gleam/dynamic.gleam b/src/gleam/dynamic.gleam
index cd70f93..f29621d 100644
--- a/src/gleam/dynamic.gleam
+++ b/src/gleam/dynamic.gleam
@@ -375,27 +375,27 @@ pub fn list(
///
/// ```gleam
/// > from("Hello")
-/// > |> option(string)
+/// > |> optional(string)
/// Ok(Some("Hello"))
///
/// > from("Hello")
-/// > |> option(string)
+/// > |> optional(string)
/// Ok(Some("Hello"))
///
/// > from(atom.from_string("null"))
-/// > |> option(string)
+/// > |> optional(string)
/// Ok(None)
///
/// > from(atom.from_string("nil"))
-/// > |> option(string)
+/// > |> optional(string)
/// Ok(None)
///
/// > from(atom.from_string("undefined"))
-/// > |> option(string)
+/// > |> optional(string)
/// Ok(None)
///
/// > from(123)
-/// > |> option(string)
+/// > |> optional(string)
/// Error([DecodeError(expected: "BitString", found: "Int", path: [])])
/// ```
///