Introduce Task.Supervisor.option type

flupke · Apr 21, 2017 · 4360198 · 4360198
1 parent cad986d
commit 4360198
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/lib/elixir/lib/supervisor.ex b/lib/elixir/lib/supervisor.ex
@@ -256,11 +256,13 @@ defmodule Supervisor do
   @typedoc "The Supervisor name"
   @type name :: atom | {:global, term} | {:via, module, term}
 
+  @typedoc "Option values used by the `start*` functions"
+  @type option :: {:name, name} | {:strategy, Supervisor.Spec.strategy} |
+                  {:max_restarts, non_neg_integer} |
+                  {:max_seconds, non_neg_integer}
+
   @typedoc "Options used by the `start*` functions"
-  @type options :: [name: name,
-                    strategy: Supervisor.Spec.strategy,
-                    max_restarts: non_neg_integer,
-                    max_seconds: non_neg_integer]
+  @type options :: [option, ...]
 
   @typedoc "The supervisor reference"
   @type supervisor :: pid | name | {atom, node}

diff --git a/lib/elixir/lib/task/supervisor.ex b/lib/elixir/lib/task/supervisor.ex
@@ -17,6 +17,10 @@ defmodule Task.Supervisor do
   `GenServer`. Read more about them in the `GenServer` docs.
   """
 
+  @typedoc "Option values used by `start_link`"
+  @type option :: Supervisor.option | {:restart, Supervisor.Spec.restart} |
+                  {:shutdown, Supervisor.Spec.shutdown}
+
   @doc """
   Starts a new supervisor.
 
@@ -37,7 +41,7 @@ defmodule Task.Supervisor do
   * `:max_restarts` and `:max_seconds` - as specified in `Supervisor.Spec.supervise/2`;
 
   """
-  @spec start_link(Supervisor.options) :: Supervisor.on_start
+  @spec start_link([option]) :: Supervisor.on_start
   def start_link(opts \\ []) do
     import Supervisor.Spec
     {restart, opts}  = Keyword.pop(opts, :restart, :temporary)