Document usage of ParametrizedType inside of a composite type

elixir-ecto · Dec 22, 2024 · 039d219 · 039d219
1 parent e644970
commit 039d219
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/lib/ecto/parameterized_type.ex b/lib/ecto/parameterized_type.ex
@@ -64,6 +64,13 @@ defmodule Ecto.ParameterizedType do
         field :bar, MyApp.MyType, opt1: :baz, opt2: :boo
       end
 
+  To use this type in a schema field with a composite type, specify the type in a tuple
+  and opts afterwards.
+
+      schema "foo" do
+        field :bars, {:array, MyApp.MyType}, opt1: :baz, opt2: :boo
+      end
+
   To use this type in places where you need it to be initialized (for example,
   schemaless changesets), you can use `init/2`.