Fix typedoc of Arrays.Protocol.options

Qqwy · Sep 6, 2021 · dec2184 · dec2184
1 parent 625d368
commit dec2184
Showing 1 changed file with 3 additions and 9 deletions.
diff --git 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 """