small documentation changes

izelnakri · Oct 14, 2016 · 1af92b9 · 1af92b9
1 parent 44e18ad
commit 1af92b9
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # How does it work?
 
-PaperTrail lets you record every change in your database in a seperate database table called ```versions```. Library generates a new version record with associated data every time you run ```PaperTrail.insert/1```, ```PaperTrail.update/1``` or ```PaperTrail.destroy/1``` functions. Simply these functions wrap your Repo insert, update or destroy actions in a database transaction, so if your database action fails you won't get a new version.
+PaperTrail lets you record every change in your database in a seperate database table called ```versions```. Library generates a new version record with associated data every time you run ```PaperTrail.insert/1```, ```PaperTrail.update/1``` or ```PaperTrail.delete/1``` functions. Simply these functions wrap your Repo insert, update or destroy actions in a database transaction, so if your database action fails you won't get a new version.
 
 ## Example
 
@@ -132,9 +132,9 @@ TODO AREA:
 
 give originator example
 
-Your versions don't need a model lifecycle callbacks like before_create or before_update for any extra meta data, all your meta data could be stored in one object and that object could be passed as the second optional parameter to PaperTrail.create
+Your versions don't need a model lifecycle callbacks like before_create or before_update for any extra meta data, all your meta data could be stored in one object and that object could be passed as the second optional parameter to PaperTrail.insert || PaperTrail.update || PaperTrail.delete
 
 ## Suggestions
 
-PaperTrail.Version(s) order matter,
-don't delete your versions merge them
+- PaperTrail.Version(s) order matter,
+- don't delete your versions merge them
diff --git a/doc/404.html b/doc/404.html
@@ -8,6 +8,8 @@
     <title>404 – paper_trail v0.1.6</title>
     <link rel="stylesheet" href="dist/app-88251e7c81.css" />
 
+      <link rel="canonical" href="https://hexdocs.pm/paper_trail/404.html" />
+
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="extras">

diff --git a/doc/Mix.Tasks.Papertrail.Install.html b/doc/Mix.Tasks.Papertrail.Install.html
@@ -8,6 +8,8 @@
     <title>Mix.Tasks.Papertrail.Install – paper_trail v0.1.6</title>
     <link rel="stylesheet" href="dist/app-88251e7c81.css" />
 
+      <link rel="canonical" href="https://hexdocs.pm/paper_trail/Mix.Tasks.Papertrail.Install.html" />
+
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="modules">

diff --git a/doc/PaperTrail.Migration.html b/doc/PaperTrail.Migration.html
@@ -8,6 +8,8 @@
     <title>PaperTrail.Migration – paper_trail v0.1.6</title>
     <link rel="stylesheet" href="dist/app-88251e7c81.css" />
 
+      <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.Migration.html" />
+
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="modules">

diff --git a/doc/PaperTrail.Version.html b/doc/PaperTrail.Version.html
@@ -8,6 +8,8 @@
     <title>PaperTrail.Version – paper_trail v0.1.6</title>
     <link rel="stylesheet" href="dist/app-88251e7c81.css" />
 
+      <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.Version.html" />
+
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="modules">

diff --git a/doc/PaperTrail.VersionQueries.html b/doc/PaperTrail.VersionQueries.html
@@ -8,6 +8,8 @@
     <title>PaperTrail.VersionQueries – paper_trail v0.1.6</title>
     <link rel="stylesheet" href="dist/app-88251e7c81.css" />
 
+      <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.VersionQueries.html" />
+
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="modules">

diff --git a/doc/PaperTrail.html b/doc/PaperTrail.html
@@ -8,6 +8,8 @@
     <title>PaperTrail – paper_trail v0.1.6</title>
     <link rel="stylesheet" href="dist/app-88251e7c81.css" />
 
+      <link rel="canonical" href="https://hexdocs.pm/paper_trail/PaperTrail.html" />
+
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="modules">

diff --git a/doc/api-reference.html b/doc/api-reference.html
@@ -8,6 +8,8 @@
     <title>API Reference – paper_trail v0.1.6</title>
     <link rel="stylesheet" href="dist/app-88251e7c81.css" />
 
+      <link rel="canonical" href="https://hexdocs.pm/paper_trail/api-reference.html" />
+
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="extras">