aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Jones <m.pricejones@gmail.com>2021-08-08 14:16:19 +0100
committerLouis Pilfold <louis@lpil.uk>2021-08-13 18:13:35 +0100
commitbe9cfdb162800bf96990c15d4e205d768cc3f22d (patch)
tree1af7c3c0dca036ce21fc8869a06115ae0b931514
parentafe9581a11c2f183b8778c40a89412fa3e233c99 (diff)
downloadgleam_stdlib-be9cfdb162800bf96990c15d4e205d768cc3f22d.tar.gz
gleam_stdlib-be9cfdb162800bf96990c15d4e205d768cc3f22d.zip
Update doc comments/results
I had failed to update them for the new format. Some of them seem to be inconsistent as well. Not sure though.
-rw-r--r--src/gleam/dynamic.gleam77
1 files changed, 39 insertions, 38 deletions
diff --git a/src/gleam/dynamic.gleam b/src/gleam/dynamic.gleam
index c180884..a3d1549 100644
--- a/src/gleam/dynamic.gleam
+++ b/src/gleam/dynamic.gleam
@@ -42,7 +42,7 @@ if erlang {
/// True
///
/// > bit_string(from(123))
- /// Error("Expected a BitString, found `123`")
+ /// Error(DecoderError(expected: "bit_string", found: "int"))
///
pub external fn bit_string(from: Dynamic) -> Result(BitString, DecodeError) =
"gleam_stdlib" "decode_bit_string"
@@ -56,7 +56,7 @@ if erlang {
/// Ok("Hello")
///
/// > string(from(123))
- /// Error("Expected a String, found `123`")
+ /// Error(DecoderError(expected: "string", found: "int"))
///
pub fn string(from: Dynamic) -> Result(String, DecodeError) {
bit_string(from)
@@ -78,7 +78,7 @@ if erlang {
/// Ok(123)
///
/// > int(from("Hello"))
- /// Error("Expected an Int, found `\"Hello World\"`")
+ /// Error(DecoderError(expected: "int", found: "string"))
///
pub external fn int(from: Dynamic) -> Result(Int, DecodeError) =
"gleam_stdlib" "decode_int"
@@ -92,7 +92,7 @@ if erlang {
/// Ok(2.0)
///
/// > float(from(123))
- /// Error("Expected a Float, found `123`")
+ /// Error(DecoderError(expected: "float", found: "int"))
///
pub external fn float(from: Dynamic) -> Result(Float, DecodeError) =
"gleam_stdlib" "decode_float"
@@ -106,7 +106,7 @@ if erlang {
/// Ok(True)
///
/// > bool(from(123))
- /// Error("Expected a Bool, found `123`")
+ /// Error(DecoderError(expected: "bool", found: "int"))
///
pub external fn bool(from: Dynamic) -> Result(Bool, DecodeError) =
"gleam_stdlib" "decode_bool"
@@ -122,7 +122,7 @@ if erlang {
/// True
///
/// > thunk(from(123))
- /// Error("Expected a zero arity function, found `123`")
+ /// Error(DecoderError(expected: "zero arity function", found: "int"))
///
pub external fn thunk(from: Dynamic) -> Result(fn() -> Dynamic, DecodeError) =
"gleam_stdlib" "decode_thunk"
@@ -139,7 +139,7 @@ if erlang {
/// Ok([from("a"), from("b"), from("c")])
///
/// > list(1)
- /// Error("Expected an Int, found a binary")
+ /// Error(DecoderError(expected: "int", found: "binary"))
///
pub external fn list(from: Dynamic) -> Result(List(Dynamic), DecodeError) =
"gleam_stdlib" "decode_list"
@@ -156,7 +156,7 @@ if erlang {
/// Ok(Error(from("boom")))
///
/// > result(from(123))
- /// Error("Expected a 2 element tuple, found an int")
+ /// Error(DecoderError(expected: "2 element tuple", found: "int"))
///
pub external fn result(
Dynamic,
@@ -178,7 +178,7 @@ if erlang {
/// Ok(Error("boom"))
///
/// > typed_result(of: from(123), ok: int, error: string)
- /// Error("Expected a 2 element tuple, found an int")
+ /// Error(DecoderError(expected: "2 element tuple", found: "int"))
///
pub fn typed_result(
of dynamic: Dynamic,
@@ -215,10 +215,10 @@ if erlang {
/// Ok(["a", "b", "c"])
///
/// > typed_list(from([1, 2, 3]), of: string)
- /// Error("Expected an Int, found a binary")
+ /// Error(DecoderError(expected: "int", found: "binary"))
///
/// > typed_list(from("ok"), of: string)
- /// Error("Expected a List, found a binary")
+ /// Error(DecoderError(expected: "list", found: "binary"))
///
pub fn typed_list(
from dynamic: Dynamic,
@@ -250,7 +250,7 @@ if erlang {
/// Ok(None)
///
/// > option(from(123), string)
- /// Error("Expected a bit_string, found an int")
+ /// Error(DecoderError(expected: "bit_string", found: "int"))
///
pub external fn optional(
from: Dynamic,
@@ -270,7 +270,7 @@ if erlang {
/// Ok(Dynamic)
///
/// > field(from(123), "Hello")
- /// Error("Expected a map with key `\"Hello\"`, found an Int")
+ /// Error(DecoderError(expected: "map", found: "int"))
///
pub external fn field(from: Dynamic, named: a) -> Result(Dynamic, DecodeError) =
"gleam_stdlib" "decode_field"
@@ -284,10 +284,10 @@ if erlang {
/// Ok(from(1))
///
/// > element(from(#(1, 2)), 2)
- /// Error("Expected a tuple of at least 3 size, found a tuple of 2 size")
+ /// Error(DecoderError(expected: "3 element tuple", found: "2 element tuple"))
///
/// > element(from(""), 2)
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "tuple", found: "binary"))
///
pub external fn element(
from: Dynamic,
@@ -306,10 +306,10 @@ if erlang {
/// Ok(#(from(1), from(2)))
///
/// > tuple2(from(#(1, 2, 3)))
- /// Error("Expected a 2 element tuple")
+ /// Error(DecoderError(expected: "2 element tuple", found: "3 element tuple"))
///
/// > tuple2(from(""))
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "2 element tuple", found: "binary"))
///
pub external fn tuple2(
from: Dynamic,
@@ -331,10 +331,10 @@ if erlang {
/// Ok(#(1, 2.0))
///
/// > typed_tuple2(from(#(1, 2, 3)), int, float)
- /// Error("Expected a 2 element tuple, found a 3 element tuple")
+ /// Error(DecoderError(expected: "2 element tuple", found: "3 element tuple"))
///
/// > typed_tuple2(from(""), int, float)
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "2 element tuple", found: "binary"))
///
pub fn typed_tuple2(
from tup: Dynamic,
@@ -358,10 +358,10 @@ if erlang {
/// Ok(#(from(1), from(2), from(3)))
///
/// > tuple3(from(#(1, 2)))
- /// Error("Expected a 3 element tuple")
+ /// Error(DecoderError(expected: "3 element tuple", found: "3 element tuple"))
///
/// > tuple3(from(""))
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "3 element tuple", found: "binary"))
///
pub external fn tuple3(
from: Dynamic,
@@ -383,10 +383,10 @@ if erlang {
/// Ok(#(1, 2.0, "3"))
///
/// > typed_tuple3(from(#(1, 2)), int, float, string)
- /// Error("Expected a 3 element tuple, found a 2 element tuple")
+ /// Error(DecoderError(expected: "3 element tuple", found: "2 element tuple"))
///
/// > typed_tuple3(from(""), int, float, string)
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "3 element tuple", found: "binary"))
///
pub fn typed_tuple3(
from tup: Dynamic,
@@ -412,10 +412,10 @@ if erlang {
/// Ok(#(from(1), from(2), from(3), from(4)))
///
/// > tuple4(from(#(1, 2)))
- /// Error("Expected a 4 element tuple")
+ /// Error(DecoderError(expected: "4 element tuple", found: "2 element tuple"))
///
/// > tuple4(from(""))
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "4 element tuple", found: "binary"))
///
pub external fn tuple4(
from: Dynamic,
@@ -438,9 +438,10 @@ if erlang {
///
/// > typed_tuple4(from(#(1, 2)), int, float, string, int)
/// Error("Expected a 4 element tuple, found a 2 element tuple")
+ /// Error(DecoderError(expected: "4 element tuple", found: "2 element tuple"))
///
/// > typed_tuple4(from(""), int, float, string, int)
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "4 element tuple", found: "binary"))
///
pub fn typed_tuple4(
from tup: Dynamic,
@@ -468,10 +469,10 @@ if erlang {
/// Ok(#(from(1), from(2), from(3), from(4), from(5)))
///
/// > tuple5(from(#(1, 2)))
- /// Error("Expected a 5 element tuple")
+ /// Error(DecoderError(expected: "5 element tuple", found: "2 element tuple"))
///
/// > tuple5(from(""))
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "5 element tuple", found: "binary"))
///
pub external fn tuple5(
from: Dynamic,
@@ -493,10 +494,10 @@ if erlang {
/// Ok(#(1, 2.0, "3", 4, 5))
///
/// > typed_tuple5(from(#(1, 2)), int, float, string, int, int)
- /// Error("Expected a 5 element tuple, found a 2 element tuple")
+ /// Error(DecoderError(expected: "5 element tuple", found: "2 element tuple"))
///
/// > typed_tuple5(from(""), int, float, string, int, int)
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "5 element tuple", found: "binary"))
///
pub fn typed_tuple5(
from tup: Dynamic,
@@ -526,10 +527,10 @@ if erlang {
/// Ok(#(from(1), from(2), from(3), from(4), from(5), from(6)))
///
/// > tuple6(from(#(1, 2)))
- /// Error("Expected a 6 element tuple")
+ /// Error(DecoderError(expected: "6 element tuple", found: "2 element tuple"))
///
/// > tuple6(from(""))
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "6 element tuple", found: "binary"))
///
pub external fn tuple6(
from: Dynamic,
@@ -554,10 +555,10 @@ if erlang {
/// Ok(#(1, 2.0, "3", 4, 5, 6))
///
/// > typed_tuple6(from(#(1, 2)), int, float, string, int, int, int)
- /// Error("Expected a 6 element tuple, found a 2 element tuple")
+ /// Error(DecoderError(expected: "6 element tuple", found: "2 element tuple"))
///
/// > typed_tuple6(from(""), int, float, string, int, int, int)
- /// Error("Expected a tuple, found a binary")
+ /// Error(DecoderError(expected: "6 element tuple", found: "binary"))
///
pub fn typed_tuple6(
from tup: Dynamic,
@@ -587,10 +588,10 @@ if erlang {
/// Ok(map.new())
///
/// > map(from(1))
- /// Error("Expected a 2 element tuple, found an int")
+ /// Error(DecoderError(expected: "map", found: "int"))
///
/// > map(from(""))
- /// Error("Expected a map, found a binary")
+ /// Error(DecoderError(expected: "map", found: "binary"))
///
pub external fn map(
from: Dynamic,
@@ -614,7 +615,7 @@ if erlang {
/// Ok("a bool")
///
/// > bool_or_string(from(1))
- /// Error("Unexpected value")
+ /// Error(DecoderError(expected: "unknown", found: "unknown"))
///
pub fn any(
from data: Dynamic,
@@ -623,7 +624,7 @@ if erlang {
decoders
|> list.find_map(fn(decoder) { decoder(data) })
|> result.map_error(fn(_) {
- DecodeError(expected: "any", found: "unexpected")
+ DecodeError(expected: "unknown", found: "unknown")
})
}
}