Add minor doc notes and specs

whitfin · Sep 25, 2024 · 55898cb · 55898cb
1 parent 7aa2f5d
commit 55898cb
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/lib/cachex.ex b/lib/cachex.ex
@@ -281,7 +281,11 @@ defmodule Cachex do
     end
   end
 
-  # Cachex.start_link/1 exists for child specifications
+  @doc false
+  # Grace handlers for `Supervisor.child_spec/1`.
+  #
+  # Without this, Cachex is not compatible per Elixir's documentation.
+  @spec start_link(atom | Keyword.t()) :: {atom, pid} | {:error, :invalid_name}
   def start_link(options) when is_list(options) do
     case Keyword.fetch(options, :name) do
       {:ok, name} ->