Merge pull request #3 from gordalina/sg/fix-doc

Fix documentation
gordalina · Jun 9, 2021 · 8dd8a99 · 8dd8a99
2 parents cb359e1 + c08df44
commit 8dd8a99
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/lib/hush.ex b/lib/hush.ex
@@ -4,16 +4,16 @@ defmodule Hush do
   """
 
   @doc """
-  Resolve configuration of all loaded applications
+  Resolve configuration
+
+  When called with resolve!/0 it will default to all loaded applications' configuration.
+  When called with resolve!/1 with the configuration as an arugment it will process that.
   """
   @spec resolve!() :: Keyword.t()
   def resolve!() do
     runtime_config() |> resolve!()
   end
 
-  @doc """
-  Resolve configuration passed as an argument
-  """
   @spec resolve!(Keyword.t()) :: Keyword.t()
   def resolve!(config) when is_list(config) do
     config |> load_providers!()