From 9b490ca9aa5ec6d61ab9573551cac19185786e31 Mon Sep 17 00:00:00 2001 From: Izel Nakri Date: Sat, 29 Jun 2019 16:21:49 +0200 Subject: [PATCH] v0.8.2 docs update --- README.md | 5 +- doc/.build | 15 +- doc/404.html | 75 ++++--- doc/Mix.Tasks.Papertrail.Install.html | 101 +++++---- doc/PaperTrail.RepoClient.html | 121 +++++----- doc/PaperTrail.Version.html | 166 +++++++------- doc/PaperTrail.VersionQueries.html | 181 ++++++++------- doc/PaperTrail.html | 300 +++++++++++++------------ doc/api-reference.html | 74 +++--- doc/dist/app-240d7fc7e5.css | 1 - doc/dist/app-a0c90688fa.js | 7 - doc/dist/html-d9f58a6320b5bfa6dd77.css | 3 + doc/dist/html-d9f58a6320b5bfa6dd77.js | 89 ++++++++ doc/dist/html/fonts/icomoon.eot | Bin 0 -> 3380 bytes doc/dist/html/fonts/icomoon.svg | 19 ++ doc/dist/html/fonts/icomoon.ttf | Bin 0 -> 3216 bytes doc/dist/html/fonts/icomoon.woff | Bin 0 -> 3292 bytes doc/dist/search_items-6c2e4c630f.js | 1 + doc/dist/sidebar_items-54af3ecba9.js | 1 - doc/dist/sidebar_items-751b1548bc.js | 1 + doc/fonts/icomoon.eot | Bin 3096 -> 0 bytes doc/fonts/icomoon.svg | 18 -- doc/fonts/icomoon.ttf | Bin 2932 -> 0 bytes doc/fonts/icomoon.woff | Bin 3008 -> 0 bytes doc/index.html | 4 +- doc/search.html | 71 +++--- 26 files changed, 702 insertions(+), 551 deletions(-) delete mode 100644 doc/dist/app-240d7fc7e5.css delete mode 100644 doc/dist/app-a0c90688fa.js create mode 100644 doc/dist/html-d9f58a6320b5bfa6dd77.css create mode 100644 doc/dist/html-d9f58a6320b5bfa6dd77.js create mode 100644 doc/dist/html/fonts/icomoon.eot create mode 100644 doc/dist/html/fonts/icomoon.svg create mode 100644 doc/dist/html/fonts/icomoon.ttf create mode 100644 doc/dist/html/fonts/icomoon.woff create mode 100644 doc/dist/search_items-6c2e4c630f.js delete mode 100644 doc/dist/sidebar_items-54af3ecba9.js create mode 100644 doc/dist/sidebar_items-751b1548bc.js delete mode 100644 doc/fonts/icomoon.eot delete mode 100644 doc/fonts/icomoon.svg delete mode 100644 doc/fonts/icomoon.ttf delete mode 100644 doc/fonts/icomoon.woff diff --git a/README.md b/README.md index 9fee51df..5ddc1bc6 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ The library source code is minimal and well tested. It is suggested to read the ```elixir def deps do - [{:paper_trail, "~> 0.8.1"}] + [{:paper_trail, "~> 0.8.2"}] end ``` @@ -185,7 +185,7 @@ You can specify setter/originator relationship to paper_trail versions with ```o # For most applications originator should be the user since models can be updated/created/deleted by several users. ``` -Note: You will need to recompile your deps after you have added the config for originator. +Note: You will need to recompile your deps after you have added the config for originator. Then originator name could be used for querying and preloading. Originator setting must be done via ```:originator``` or originator name that is defined in the paper_trail configuration: @@ -442,6 +442,7 @@ PaperTrail.get_versions(User, id, [prefix: tenant]) # Credits Many thanks to: - [Jose Pablo Castro](https://github.com/josepablocastro) - Built the repo configuration for paper_trail +- [Florian Gerhardt](https://github.com/FlorianGerhardt) - Fixed rare compile errors for PaperTrail repos - [Alex Antonov](https://github.com/asiniy) - Original inventor of the originator feature - [Moritz Schmale](https://github.com/narrowtux) - UUID primary keys feature - [Jason Draper](https://github.com/drapergeek) - UUID primary keys feature diff --git a/doc/.build b/doc/.build index eceac033..369ab43d 100644 --- a/doc/.build +++ b/doc/.build @@ -1,10 +1,11 @@ -dist/app-240d7fc7e5.css -dist/app-a0c90688fa.js -fonts/icomoon.eot -fonts/icomoon.svg -fonts/icomoon.ttf -fonts/icomoon.woff -dist/sidebar_items-54af3ecba9.js +dist/search_items-6c2e4c630f.js +dist/html-d9f58a6320b5bfa6dd77.css +dist/html-d9f58a6320b5bfa6dd77.js +dist/html/fonts/icomoon.eot +dist/html/fonts/icomoon.svg +dist/html/fonts/icomoon.ttf +dist/html/fonts/icomoon.woff +dist/sidebar_items-751b1548bc.js api-reference.html search.html 404.html diff --git a/doc/404.html b/doc/404.html index 188a0c46..e488e47f 100644 --- a/doc/404.html +++ b/doc/404.html @@ -4,43 +4,51 @@ - - 404 – paper_trail v0.8.1 - + + + 404 — paper_trail v0.8.2 + - - + + +
+ - -
- - diff --git a/doc/Mix.Tasks.Papertrail.Install.html b/doc/Mix.Tasks.Papertrail.Install.html index 3a50970d..3eb052de 100644 --- a/doc/Mix.Tasks.Papertrail.Install.html +++ b/doc/Mix.Tasks.Papertrail.Install.html @@ -4,43 +4,51 @@ - - papertrail.install – paper_trail v0.8.1 - + + + mix papertrail.install — paper_trail v0.8.2 + - - + + + -
+
+ - -
- - -

Link to this section - Functions -

-
-
+Functions +
+
+ +

run(args) +

A task needs to implement run which receives a list of command line args.

Callback implementation for Mix.Task.run/1.

-
+
+ - -