Merge branch 'preload' into get_by

dwyl · Oct 31, 2018 · 58665fa · 58665fa
2 parents f03c4b3 + 2436fe6
commit 58665fa
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/alog.ex b/lib/alog.ex
@@ -30,6 +30,12 @@ defmodule Alog do
 
   Alog expects your `Repo` to belong to the same base module as the schema.
   So if your schema is `MyApp.User`, or `MyApp.Accounts.User`, your Repo should be `MyApp.Repo`.
+
+  Any schema that uses Alog must include the fields `:deleted` of type `:boolean` and default false,
+  and `:entry_id` of type `:string`.
+
+        field(:deleted, :boolean, default: false)
+        field(:entry_id, :string)
   """
 
   @callback insert(map()) :: {:ok, Ecto.Schema.t()} | {:error, Ecto.Changeset.t()}