Document error message interpolation (#3538)

elixir-ecto · Jan 14, 2021 · 9649486 · 9649486
1 parent f832a27
commit 9649486
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/lib/ecto/changeset.ex b/lib/ecto/changeset.ex
@@ -1617,7 1617,7 @@ defmodule Ecto.Changeset do
 
  An additional keyword list `keys` can be passed to provide additional
  contextual information for the error. This is useful when using
- `traverse_errors/2`
  `traverse_errors/2` and when translating errors with `Gettext`
 
  ## Examples
 
@@ -1634,6 1634,13 @@ defmodule Ecto.Changeset do
  [title: {"empty", [additional: "info"]}]
  iex> changeset.valid?
  false
 
  iex> changeset = change(%Post{}, %{tags: ["ecto", "elixir", "x"]})
  iex> changeset = add_error(changeset, :tags, "tag '%{val}' is too short", val: "x")
  iex> changeset.errors
  [tags: {"tag '%{val}' is too short", [val: "x"]}]
  iex> changeset.valid?
  false
  """
  @spec add_error(t, atom, String.t, Keyword.t) :: t
  def add_error(%Changeset{errors: errors} = changeset, key, message, keys \\ []) when is_binary(message) do