From c20a7ff73a3938bf32efa9b57ed3b5e9758724f6 Mon Sep 17 00:00:00 2001 From: bolte-17 <3034257+bolte-17@users.noreply.github.com> Date: Thu, 12 Aug 2021 16:38:22 -0400 Subject: [PATCH] Fix documentation typo for history :render_struct option --- lib/repo/repo.ex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/repo/repo.ex b/lib/repo/repo.ex index d9a6d0e..6bfc71c 100644 --- a/lib/repo/repo.ex +++ b/lib/repo/repo.ex @@ -219,7 +219,7 @@ defmodule ExAudit.Repo do Gathers the version history for the given struct, ordered by the time the changes happened from newest to oldest. ### Options - * `:render_structs` if true, renders the _resulting_ struct of the patch for every version in its history. + * `:render_struct` if true, renders the _resulting_ struct of the patch for every version in its history. This will shift the ids of the versions one down, so visualisations are correct and corresponding "Revert" buttons revert the struct back to the visualized state. Will append an additional version that contains the oldest ID and the oldest struct known. In most cases, the