[FIX] wrong specs for start_link/1 and child_spec/1

README.md

@@ -102,6 +102,7 @@ end
 
 ## Changelog
 
+* `0.11.2` — [FIX] wrong specs for `start_link/1` and `child_spec/1`
 * `0.11.1` — upgraded to `Finitomata` (`v0.11.0`)
 * `0.11.0` — throttler → generic + on perform
 * `0.10.3` — accept `{(any() -> :ok), timeout}` as `die_with_children`, write-only `InternalState`

lib/siblings.ex

@@ -29,6 +29,14 @@ defmodule Siblings do
           options: InternalWorker.options()
         }
 
+  @type start_options :: [
+          {:name, atom()}
+          | {:workers, [worker() | {module(), keyword()}]}
+          | {:callbacks, [function()]}
+          | {:throttler, keyword()}
+          | {:die_with_children, boolean() | (() -> :ok) | {(() -> :ok), non_neg_integer()}}
+        ]
+
   @doc """
   Starts the supervision subtree, holding the `PartitionSupervisor`.
 
@@ -51,6 +59,7 @@ defmodule Siblings do
     (if a function of arity 0 is given, it’ll be called before the process shuts down)
   - `callbacks: list()` the list of the handler to call back upon `Lookup` transitions
   """
+  @spec start_link(start_options()) :: Supervisor.on_start()
   def start_link(opts \\ []) do
     {name, opts} =
       Keyword.get_and_update(opts, :name, fn
@@ -142,10 +151,7 @@ defmodule Siblings do
 
   Useful when many `Siblings` processes are running simultaneously.
   """
-  @spec child_spec([
-          {:name, module()} | {:lookup, boolean() | module()} | {:id, any()} | keyword()
-        ]) ::
-          Supervisor.child_spec()
+  @spec child_spec(start_options()) :: Supervisor.child_spec()
   def child_spec(opts) do
     {id, opts} = Keyword.pop(opts, :id, Keyword.get(opts, :name, default_fqn()))
     %{id: id, start: {Siblings, :start_link, [opts]}}

mix.exs

@@ -2,7 +2,7 @@ defmodule Siblings.MixProject do
   use Mix.Project
 
   @app :siblings
-  @version "0.11.1"
+  @version "0.11.2"
 
   def project do
     [

mix.lock

@@ -3,12 +3,12 @@
   "bunt": {:hex, :bunt, "0.2.1", "e2d4792f7bc0ced7583ab54922808919518d0e57ee162901a16a1b6664ef3b14", [:mix], [], "hexpm", "a330bfb4245239787b15005e66ae6845c9cd524a288f0d141c148b02603777a5"},
   "credo": {:hex, :credo, "1.6.7", "323f5734350fd23a456f2688b9430e7d517afb313fbd38671b8a4449798a7854", [:mix], [{:bunt, "~> 0.2.1", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2.8", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "41e110bfb007f7eda7f897c10bf019ceab9a0b269ce79f015d54b0dcf4fc7dd3"},
   "dialyxir": {:hex, :dialyxir, "1.2.0", "58344b3e87c2e7095304c81a9ae65cb68b613e28340690dfe1a5597fd08dec37", [:mix], [{:erlex, ">= 0.2.6", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "61072136427a851674cab81762be4dbeae7679f85b1272b6d25c3a839aff8463"},
-  "earmark_parser": {:hex, :earmark_parser, "1.4.29", "149d50dcb3a93d9f3d6f3ecf18c918fb5a2d3c001b5d3305c926cddfbd33355b", [:mix], [], "hexpm", "4902af1b3eb139016aed210888748db8070b8125c2342ce3dcae4f38dcc63503"},
+  "earmark_parser": {:hex, :earmark_parser, "1.4.30", "0b938aa5b9bafd455056440cdaa2a79197ca5e693830b4a982beada840513c5f", [:mix], [], "hexpm", "3b5385c2d36b0473d0b206927b841343d25adb14f95f0110062506b300cd5a1b"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "ex_doc": {:hex, :ex_doc, "0.29.1", "b1c652fa5f92ee9cf15c75271168027f92039b3877094290a75abcaac82a9f77", [:mix], [{:earmark_parser, "~> 1.4.19", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "b7745fa6374a36daf484e2a2012274950e084815b936b1319aeebcf7809574f6"},
   "file_system": {:hex, :file_system, "0.2.10", "fb082005a9cd1711c05b5248710f8826b02d7d1784e7c3451f9c1231d4fc162d", [:mix], [], "hexpm", "41195edbfb562a593726eda3b3e8b103a309b733ad25f3d642ba49696bf715dc"},
   "finitomata": {:hex, :finitomata, "0.11.3", "1f2e39e35c4b4df413c6209b8a598810df3bb0dfab0dd8037f75abd7f3b7096d", [:mix], [{:boundary, "~> 0.4", [hex: :boundary, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.5", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "91c2a4c26823a9223a47c767f2336f0699ba08f90eb148df96db4af2f645479b"},
-  "gen_stage": {:hex, :gen_stage, "1.1.2", "b1656cd4ba431ed02c5656fe10cb5423820847113a07218da68eae5d6a260c23", [:mix], [], "hexpm", "9e39af23140f704e2b07a3e29d8f05fd21c2aaf4088ff43cb82be4b9e3148d02"},
+  "gen_stage": {:hex, :gen_stage, "1.2.0", "ee49244b57803f54bdab08a60a927e1b4e5bb5d635c52eca0f376a0673af3f8c", [:mix], [], "hexpm", "c3e40992c72e74d9c4eda16d7515bf32c9e7b634e827ab11091fff3290f7b503"},
   "jason": {:hex, :jason, "1.4.0", "e855647bc964a44e2f67df589ccf49105ae039d4179db7f6271dfd3843dc27e6", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "79a3791085b2a0f743ca04cec0f7be26443738779d09302e01318f97bdb82121"},
   "makeup": {:hex, :makeup, "1.1.0", "6b67c8bc2882a6b6a445859952a602afc1a41c2e08379ca057c0f525366fc3ca", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "0a45ed501f4a8897f580eabf99a2e5234ea3e75a4373c8a52824f6e873be57a6"},
   "makeup_elixir": {:hex, :makeup_elixir, "0.16.0", "f8c570a0d33f8039513fbccaf7108c5d750f47d8defd44088371191b76492b0b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "28b2cbdc13960a46ae9a8858c4bebdec3c9a6d7b4b9e7f4ed1502f8159f338e7"},