Add some typedocs to Ecto.Multi to clarify usage (#4155)

elixir-ecto · Apr 13, 2023 · 0a265ee · 0a265ee
1 parent f3311ee
commit 0a265ee
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/lib/ecto/multi.ex b/lib/ecto/multi.ex
@@ -119,6  119,11 @@ defmodule Ecto.Multi do
 
   defstruct operations: [], names: MapSet.new()
 
   @typedoc """
   Map of changes made so far during the current transaction. For any Multi
   which returns `{:ok, result}`, its `t:name/0` is added as a key and its
   result as the value.
   """
   @type changes :: map
   @type run :: ((Ecto.Repo.t, changes) -> {:ok | :error, any})
   @type fun(result) :: (changes -> result)
@@ -133,7  138,14 @@ defmodule Ecto.Multi do
                       {:delete_all, Ecto.Query.t, Keyword.t} |
                       {:insert_all, schema_or_source, [map | Keyword.t], Keyword.t}
   @typep operations :: [{name, operation}]
 
   @typep names :: MapSet.t
 
   @typedoc """
   Name of an operation in the Multi. Can be any term, as long as it is unique
   within the list of operations; for example, `:insert_post` or `{:delete_post,
   5}`.
   """
   @type name :: any
   @type t :: %__MODULE__{operations: operations, names: names}