docs: improve add_to_ash_postgres task docs

ash-project · Jul 15, 2024 · bbbbcc3 · bbbbcc3
1 parent 5843ee7
commit bbbbcc3
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/lib/mix/tasks/ash_money.add_to_ash_postgres.ex b/lib/mix/tasks/ash_money.add_to_ash_postgres.ex
@@ -1,6 +1,11 @@
 defmodule Mix.Tasks.AshMoney.AddToAshPostgres do
-  @moduledoc "Adds AshMoney.AshPostgresExtension to installed_extensions and installs :ex_money_sql."
-  @shortdoc @moduledoc
+  @shortdoc "Adds AshMoney.AshPostgresExtension to installed_extensions and installs :ex_money_sql."
+  @moduledoc """
+  #{@shortdoc}
+
+  This is called automatically by `mix igniter.install ash_money` if `AshPostgres` is installed at the time.
+  This task is useful if you install `ash_postgres` *after* installing `ash_money`.
+  """
   require Igniter.Code.Common
   use Igniter.Mix.Task