From dec2184a0c9c3d60ea95ab5aefc7de503f9488e0 Mon Sep 17 00:00:00 2001 From: Marten/Qqwy Date: Mon, 6 Sep 2021 18:43:33 +0200 Subject: [PATCH] Fix typedoc of Arrays.Protocol.options --- lib/arrays/protocol.ex | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/lib/arrays/protocol.ex b/lib/arrays/protocol.ex index 3c4df14..135931a 100644 --- a/lib/arrays/protocol.ex +++ b/lib/arrays/protocol.ex @@ -120,17 +120,11 @@ defprotocol Arrays.Protocol do def slice(array, start_index, amount) @typedoc """ - Option passed to `c:empty/1`. + A list of options passed to `c:empty/1`. - The option `:default` is recognized by all array implementations. - A particular array implementation might recognize other specialized options. + What options are recognized by a particular implementation varies. """ - @type option :: {:default, any} | {atom, any} - - @typedoc """ - A list of options passed to `c:empty/1` - """ - @type options :: [option] + @type options :: Keyword.t() @doc """