Skip to content

Commit

Permalink
Fix documentation typo for history :render_struct option
Browse files Browse the repository at this point in the history
  • Loading branch information
bolte-17 committed Aug 12, 2021
1 parent e5d6ab4 commit c20a7ff
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/repo/repo.ex
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c20a7ff

Please sign in to comment.