updated docs for 1.6.1 release

taxjar · Oct 18, 2017 · 7f1ced1 · 7f1ced1
1 parent de937dd
commit 7f1ced1
Show file tree

Hide file tree

Showing 27 changed files with 151 additions and 136 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.6.1
+- Fixed bug where `Xlsxir.get_cell/2` raised instead of returning `nil` on non-existing cell. Thanks to @ZombieHarvester for contribution.
+- Various documentation updates.
+
 ## 1.6.0
 - Huge parsing performance improvement thanks to Alex Kovalevych's (@AlexKovalevych) contribution.
 - Ability to choose between parsing in-memory or on the file system added as well as the ability to stream via the `Xlsxir.stream_list/2`. Thanks to Thibaut Decaudain (@Tricote) for contribution. 

diff --git a/OVERVIEW.md b/OVERVIEW.md
@@ -8,15 +8,15 @@ You can add Xlsxir as a dependancy to your Elixir project via the Hex package ma
 
 ```elixir
 def deps do
-  [ {:xlsxir, "~> 1.6.0"} ]
+  [ {:xlsxir, "~> 1.6.1"} ]
 end
 ```
 
 Or, you can directly reference the GitHub repo:
 
 ```elixir
 def deps do
-  [ {:xlsxir, github: "jsonkennell/xlsxir"} ]
+  [ {:xlsxir, github: "jsonkenl/xlsxir"} ]
 end
 ```
 

diff --git a/README.md b/README.md
@@ -13,15 +13,15 @@ You can add Xlsxir as a dependency to your Elixir project via the Hex package ma
 
 ```elixir
 def deps do
-  [ {:xlsxir, "~> 1.6.0"} ]
+  [ {:xlsxir, "~> 1.6.1"} ]
 end
 ```
 
 Or, you can directly reference the GitHub repo:
 
 ```elixir
 def deps do
-  [ {:xlsxir, github: "jsonkennell/xlsxir"} ]
+  [ {:xlsxir, github: "jsonkenl/xlsxir"} ]
 end
 ```
 

diff --git a/doc/.build b/doc/.build
@@ -4,7 +4,7 @@ fonts/icomoon.eot
 fonts/icomoon.svg
 fonts/icomoon.ttf
 fonts/icomoon.woff
-dist/sidebar_items-028c05a08e.js
+dist/sidebar_items-4813ea5825.js
 api-reference.html
 changelog.html
 number_styles.html

diff --git a/doc/404.html b/doc/404.html
@@ -5,10 +5,10 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.17.1">
-    <title>404 – Xlsxir v1.6.0</title>
+    <title>404 – Xlsxir v1.6.1</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-028c05a08e.js"></script>
+    <script src="dist/sidebar_items-4813ea5825.js"></script>
 
   </head>
   <body data-type="extras">
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.6.0
+        v1.6.1
       </h2>
     </div>
 

diff --git a/doc/Xlsxir.ConvertDate.html b/doc/Xlsxir.ConvertDate.html
@@ -5,10 +5,10 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.17.1">
-    <title>Xlsxir.ConvertDate – Xlsxir v1.6.0</title>
+    <title>Xlsxir.ConvertDate – Xlsxir v1.6.1</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-028c05a08e.js"></script>
+    <script src="dist/sidebar_items-4813ea5825.js"></script>
 
   </head>
   <body data-type="modules">
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.6.0
+        v1.6.1
       </h2>
     </div>
 
@@ -64,10 +64,10 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.6.0</small>
+        <small class="visible-xs">Xlsxir v1.6.1</small>
         Xlsxir.ConvertDate
 
-          <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/convert_date.ex#L1" title="View Source" class="view-source" rel="help">
+          <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/convert_date.ex#L1" title="View Source" class="view-source" rel="help">
             <span class="icon-code" aria-hidden="true"></span>
             <span class="sr-only">View Source</span>
           </a>
@@ -147,7 +147,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">convert_char_number(number)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/convert_date.ex#L44" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/convert_date.ex#L44" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>
@@ -170,7 +170,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">from_serial(serial)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/convert_date.ex#L20" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/convert_date.ex#L20" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>

diff --git a/doc/Xlsxir.ConvertDateTime.html b/doc/Xlsxir.ConvertDateTime.html
@@ -5,10 +5,10 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.17.1">
-    <title>Xlsxir.ConvertDateTime – Xlsxir v1.6.0</title>
+    <title>Xlsxir.ConvertDateTime – Xlsxir v1.6.1</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-028c05a08e.js"></script>
+    <script src="dist/sidebar_items-4813ea5825.js"></script>
 
   </head>
   <body data-type="modules">
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.6.0
+        v1.6.1
       </h2>
     </div>
 
@@ -64,10 +64,10 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.6.0</small>
+        <small class="visible-xs">Xlsxir v1.6.1</small>
         Xlsxir.ConvertDateTime
 
-          <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/convert_datetime.ex#L1" title="View Source" class="view-source" rel="help">
+          <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/convert_datetime.ex#L1" title="View Source" class="view-source" rel="help">
             <span class="icon-code" aria-hidden="true"></span>
             <span class="sr-only">View Source</span>
           </a>
@@ -144,7 +144,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">from_charlist(charlist)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/convert_datetime.ex#L20" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/convert_datetime.ex#L21" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>
@@ -184,7 +184,7 @@ <h2 id="from_charlist/1-example" class="section-heading">
     </a>
     <span class="signature">from_float(n)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/convert_datetime.ex#L27" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/convert_datetime.ex#L27" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>

diff --git a/doc/Xlsxir.ParseString.html b/doc/Xlsxir.ParseString.html
@@ -5,10 +5,10 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.17.1">
-    <title>Xlsxir.ParseString – Xlsxir v1.6.0</title>
+    <title>Xlsxir.ParseString – Xlsxir v1.6.1</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-028c05a08e.js"></script>
+    <script src="dist/sidebar_items-4813ea5825.js"></script>
 
   </head>
   <body data-type="modules">
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.6.0
+        v1.6.1
       </h2>
     </div>
 
@@ -64,10 +64,10 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.6.0</small>
+        <small class="visible-xs">Xlsxir v1.6.1</small>
         Xlsxir.ParseString
 
-          <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/parse_string.ex#L1" title="View Source" class="view-source" rel="help">
+          <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/parse_string.ex#L1" title="View Source" class="view-source" rel="help">
             <span class="icon-code" aria-hidden="true"></span>
             <span class="sr-only">View Source</span>
           </a>
@@ -137,7 +137,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">sax_event_handler(arg1, state)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/parse_string.ex#L21" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/parse_string.ex#L43" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>

diff --git a/doc/Xlsxir.ParseStyle.html b/doc/Xlsxir.ParseStyle.html
@@ -5,10 +5,10 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.17.1">
-    <title>Xlsxir.ParseStyle – Xlsxir v1.6.0</title>
+    <title>Xlsxir.ParseStyle – Xlsxir v1.6.1</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-028c05a08e.js"></script>
+    <script src="dist/sidebar_items-4813ea5825.js"></script>
 
   </head>
   <body data-type="modules">
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.6.0
+        v1.6.1
       </h2>
     </div>
 
@@ -64,10 +64,10 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.6.0</small>
+        <small class="visible-xs">Xlsxir v1.6.1</small>
         Xlsxir.ParseStyle
 
-          <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/parse_style.ex#L1" title="View Source" class="view-source" rel="help">
+          <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/parse_style.ex#L1" title="View Source" class="view-source" rel="help">
             <span class="icon-code" aria-hidden="true"></span>
             <span class="sr-only">View Source</span>
           </a>
@@ -137,7 +137,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">sax_event_handler(arg1, state)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/parse_style.ex#L25" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/parse_style.ex#L81" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>

diff --git a/doc/Xlsxir.ParseWorksheet.html b/doc/Xlsxir.ParseWorksheet.html
@@ -5,10 +5,10 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.17.1">
-    <title>Xlsxir.ParseWorksheet – Xlsxir v1.6.0</title>
+    <title>Xlsxir.ParseWorksheet – Xlsxir v1.6.1</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-028c05a08e.js"></script>
+    <script src="dist/sidebar_items-4813ea5825.js"></script>
 
   </head>
   <body data-type="modules">
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.6.0
+        v1.6.1
       </h2>
     </div>
 
@@ -64,10 +64,10 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.6.0</small>
+        <small class="visible-xs">Xlsxir v1.6.1</small>
         Xlsxir.ParseWorksheet
 
-          <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/parse_worksheet.ex#L1" title="View Source" class="view-source" rel="help">
+          <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/parse_worksheet.ex#L1" title="View Source" class="view-source" rel="help">
             <span class="icon-code" aria-hidden="true"></span>
             <span class="sr-only">View Source</span>
           </a>
@@ -137,7 +137,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">sax_event_handler(arg1, state, excel)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/parse_worksheet.ex#L23" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/parse_worksheet.ex#L71" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>

diff --git a/doc/Xlsxir.SaxError.html b/doc/Xlsxir.SaxError.html
@@ -5,10 +5,10 @@
     <meta http-equiv="x-ua-compatible" content="ie=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="ExDoc v0.17.1">
-    <title>Xlsxir.SaxError – Xlsxir v1.6.0</title>
+    <title>Xlsxir.SaxError – Xlsxir v1.6.1</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-028c05a08e.js"></script>
+    <script src="dist/sidebar_items-4813ea5825.js"></script>
 
   </head>
   <body data-type="exceptions">
@@ -28,7 +28,7 @@ <h1 class="sidebar-projectName">
         Xlsxir
       </h1>
       <h2 class="sidebar-projectVersion">
-        v1.6.0
+        v1.6.1
       </h2>
     </div>
 
@@ -64,10 +64,10 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Xlsxir v1.6.0</small>
+        <small class="visible-xs">Xlsxir v1.6.1</small>
         Xlsxir.SaxError <small>exception</small>
 
-          <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/sax_error.ex#L1" title="View Source" class="view-source" rel="help">
+          <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/sax_error.ex#L1" title="View Source" class="view-source" rel="help">
             <span class="icon-code" aria-hidden="true"></span>
             <span class="sr-only">View Source</span>
           </a>
@@ -140,7 +140,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">exception(msg)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/sax_error.ex#L2" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/sax_error.ex#L2" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>
@@ -151,7 +151,7 @@ <h1 class="section-heading">
 
           <pre>exception(<a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>) :: <a href="https://hexdocs.pm/elixir/Exception.html#t:t/0">Exception.t</a></pre>
 
-          <pre>exception(<a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>) :: <a href="https://hexdocs.pm/elixir/Exception.html#t:t/0">Exception.t</a></pre>
+          <pre>exception(keyword) :: <a href="https://hexdocs.pm/elixir/Exception.html#t:t/0">Exception.t</a></pre>
 
       </div>
 
@@ -171,7 +171,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">message(exception)</span>
 
-      <a href="https://github.com/jsonkennell/xlsxir/blob/master/lib/xlsxir/sax_error.ex#L2" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/jsonkenl/xlsxir/blob/master/lib/xlsxir/sax_error.ex#L2" class="view-source" rel="help" title="View Source">
        <span class="icon-code" aria-hidden="true"></span>
        <span class="sr-only">View Source</span>
      </a>