Version 0.0.2

seantanly · Jan 25, 2016 · cbeeca5 · cbeeca5
1 parent 72bc0c7
commit cbeeca5
Show file tree

Hide file tree

Showing 12 changed files with 55 additions and 57 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 Changelog
 ====
 
+## Version 0.0.2 (2016-01-26)
+
+* Remove support for Combination.combine(Enum.t, Range.t) as it is simply a `Enum.flat_map/2` of `Combination.combine/2`, which should support any Enumerable other than Range.
+
 ## Version 0.0.1 (2016-01-15)
 
 * First Version

diff --git a/doc/404.html b/doc/404.html
@@ -4,9 +4,9 @@
     <meta charset="utf-8">
     <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.11.3">
-    <title>404 – Combination v0.0.1</title>
-    <link rel="stylesheet" href="dist/app-ddd9717ad9.css" />
+    <meta name="generator" content="ExDoc v0.11.4">
+    <title>404 – Combination v0.0.2</title>
+    <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="extras">
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Combination
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.0.1
+        v0.0.2
       </h2>
     </div>
 
@@ -69,7 +69,7 @@ <h2>Page not found</h2>
       <p>
         <span class="line">
           Built using
-          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.3),
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
         </span>
         <span class="line">
           designed by

diff --git a/doc/Combination.html b/doc/Combination.html
@@ -4,9 +4,9 @@
     <meta charset="utf-8">
     <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.11.3">
-    <title>Combination – Combination v0.0.1</title>
-    <link rel="stylesheet" href="dist/app-ddd9717ad9.css" />
+    <meta name="generator" content="ExDoc v0.11.4">
+    <title>Combination – Combination v0.0.2</title>
+    <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="modules">
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Combination
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.0.1
+        v0.0.2
       </h2>
     </div>
 
@@ -59,11 +59,11 @@ <h2 class="sidebar-projectVersion">
 
 
       <h1>
-        <small class="visible-xs">Combination v0.0.1</small>
+        <small class="visible-xs">Combination v0.0.2</small>
         Combination
 
 
-          <a href="https://github.com/seantanly/elixir-combination/blob/v0.0.1/lib/combination.ex#L1" title="View Source" class="view-source" rel="help">
+          <a href="https://github.com/seantanly/elixir-combination/blob/v0.0.2/lib/combination.ex#L1" title="View Source" class="view-source" rel="help">
             <i class="icon-code"></i>
           </a>
 
@@ -72,7 +72,8 @@ <h1>
 
         <section id="moduledoc" class="docstring">
           <p>Provide a set of algorithms to generate combinations and permutations.</p>
-<p>For non-distinct elements in the source collection, simply pipe the result through <code class="inline">Enum.uniq/1</code> to remove duplicates.</p>
+<p>For source collection containing non-distinct elements, pipe the resultant list through <code class="inline">Enum.uniq/1</code>
+to remove duplicate elements.</p>
 
         </section>
 
@@ -97,7 +98,7 @@ <h2>
     <a href="#combine/2">combine(collection, k)</a>
   </div>
 
-    <div class="summary-synopsis"><p>Generate k1..k2 combinations of based on given collection, where k2 &gt; k1</p>
+    <div class="summary-synopsis"><p>Generate combinations based on given collection</p>
 </div>
 
 </div>
@@ -138,7 +139,7 @@ <h1 class="section-heading">
     </a>
     <span class="signature">combine(collection, k)</span>
 
-      <a href="https://github.com/seantanly/elixir-combination/blob/v0.0.1/lib/combination.ex#L18" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/seantanly/elixir-combination/blob/v0.0.2/lib/combination.ex#L19" class="view-source" rel="help" title="View Source">
        <i class="icon-code"></i>
      </a>
 
@@ -148,21 +149,16 @@ <h1 class="section-heading">
       <h4 class="specs-title">Specs</h4>
       <div class="specs-list">
 
-          <pre><code class="elixir">combine(<a href="http://elixir-lang.org/docs/stable/elixir/Enum.html#t:t/0">Enum.t</a>, <a href="http://elixir-lang.org/docs/stable/elixir/Range.html#t:t/0">Range.t</a>) :: [list]</code></pre>
-
           <pre><code class="elixir">combine(<a href="http://elixir-lang.org/docs/stable/elixir/Enum.html#t:t/0">Enum.t</a>, non_neg_integer) :: [list]</code></pre>
 
       </div>
     </div>
 
   <section class="docstring">
-    <p>Generate k1..k2 combinations of based on given collection, where k2 &gt; k1.</p>
+    <p>Generate combinations based on given collection.</p>
 <h2>Examples</h2>
-<pre><code class="iex elixir">iex&gt; 1..3 |&gt; Combination.combine(1..2)
-[[1], [2], [3], [3, 2], [3, 1], [2, 1]]
-
-iex&gt; 1..3 |&gt; Combination.combine(2..3)
-[[3, 2], [3, 1], [2, 1], [3, 2, 1]]</code></pre>
+<pre><code class="iex elixir">iex&gt; 1..3 |&gt; Combination.combine(2)
+[[3, 2], [3, 1], [2, 1]]</code></pre>
 
   </section>
 </div>
@@ -173,7 +169,7 @@ <h2>Examples</h2>
     </a>
     <span class="signature">permutate(collection, filter \\ fn _p -&gt; true end)</span>
 
-      <a href="https://github.com/seantanly/elixir-combination/blob/v0.0.1/lib/combination.ex#L83" class="view-source" rel="help" title="View Source">
+      <a href="https://github.com/seantanly/elixir-combination/blob/v0.0.2/lib/combination.ex#L67" class="view-source" rel="help" title="View Source">
        <i class="icon-code"></i>
      </a>
 
@@ -212,7 +208,7 @@ <h2>Example</h2>
       <p>
         <span class="line">
           Built using
-          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.3),
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
         </span>
         <span class="line">
           designed by

diff --git a/doc/api-reference.html b/doc/api-reference.html
@@ -4,9 +4,9 @@
     <meta charset="utf-8">
     <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.11.3">
-    <title>API Reference – Combination v0.0.1</title>
-    <link rel="stylesheet" href="dist/app-ddd9717ad9.css" />
+    <meta name="generator" content="ExDoc v0.11.4">
+    <title>API Reference – Combination v0.0.2</title>
+    <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="extras">
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Combination
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.0.1
+        v0.0.2
       </h2>
     </div>
 
@@ -58,7 +58,7 @@ <h2 class="sidebar-projectVersion">
   <div id="content" class="content-inner">
 
   <h1>
-    <small class="visible-xs">Combination v0.0.1</small>
+    <small class="visible-xs">Combination v0.0.2</small>
     API Reference
   </h1>
 
@@ -93,7 +93,7 @@ <h1 class="section-heading">Modules</h1>
       <p>
         <span class="line">
           Built using
-          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.3),
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
         </span>
         <span class="line">
           designed by

diff --git a/doc/changelog.html b/doc/changelog.html
@@ -4,9 +4,9 @@
     <meta charset="utf-8">
     <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.11.3">
-    <title>CHANGELOG – Combination v0.0.1</title>
-    <link rel="stylesheet" href="dist/app-ddd9717ad9.css" />
+    <meta name="generator" content="ExDoc v0.11.4">
+    <title>CHANGELOG – Combination v0.0.2</title>
+    <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="extras">
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Combination
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.0.1
+        v0.0.2
       </h2>
     </div>
 
@@ -59,6 +59,10 @@ <h2 class="sidebar-projectVersion">
 
 
 <h1>Changelog</h1>
+<h2 id="version-0-0-2-2016-01-26-"> Version 0.0.2 (2016-01-26)</h2><ul>
+<li>Remove support for Combination.combine(Enum.t, Range.t) as it is simply a <code class="inline">Enum.flat_map/2</code> of <a href="Combination.html#combine/2"><code class="inline">Combination.combine/2</code></a>, which should support any Enumerable other than Range.
+</li>
+</ul>
 <h2 id="version-0-0-1-2016-01-15-"> Version 0.0.1 (2016-01-15)</h2><ul>
 <li>First Version
 </li>
@@ -68,7 +72,7 @@ <h2 id="version-0-0-1-2016-01-15-"> Version 0.0.1 (2016-01-15)</h2><ul>
       <p>
         <span class="line">
           Built using
-          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.3),
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
         </span>
         <span class="line">
           designed by

diff --git a/doc/dist/app-1e374caa3d.css b/doc/dist/app-1e374caa3d.css
diff --git a/doc/dist/app-ddd9717ad9.css b/doc/dist/app-ddd9717ad9.css
diff --git a/doc/dist/sidebar_items.js b/doc/dist/sidebar_items.js
diff --git a/doc/index.html b/doc/index.html
@@ -2,10 +2,10 @@
 <html>
   <head>
     <meta charset="utf-8">
-    <title>Combination v0.0.1 – Documentation</title>
+    <title>Combination v0.0.2 – Documentation</title>
     <meta http-equiv="refresh" content="0; url=Combination.html">
     <meta name="robots" content="noindex">
-    <meta name="generator" content="ExDoc v0.11.3">
+    <meta name="generator" content="ExDoc v0.11.4">
   </head>
   <body></body>
 </html>
diff --git a/doc/license.html b/doc/license.html
@@ -4,9 +4,9 @@
     <meta charset="utf-8">
     <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.11.3">
-    <title>The MIT License (MIT) – Combination v0.0.1</title>
-    <link rel="stylesheet" href="dist/app-ddd9717ad9.css" />
+    <meta name="generator" content="ExDoc v0.11.4">
+    <title>The MIT License (MIT) – Combination v0.0.2</title>
+    <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="extras">
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Combination
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.0.1
+        v0.0.2
       </h2>
     </div>
 
@@ -80,7 +80,7 @@ <h1>The MIT License (MIT)</h1>
       <p>
         <span class="line">
           Built using
-          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.3),
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
         </span>
         <span class="line">
           designed by

diff --git a/doc/readme.html b/doc/readme.html
@@ -4,9 +4,9 @@
     <meta charset="utf-8">
     <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.11.3">
-    <title>README – Combination v0.0.1</title>
-    <link rel="stylesheet" href="dist/app-ddd9717ad9.css" />
+    <meta name="generator" content="ExDoc v0.11.4">
+    <title>README – Combination v0.0.2</title>
+    <link rel="stylesheet" href="dist/app-1e374caa3d.css" />
     <script src="dist/sidebar_items.js"></script>
   </head>
   <body data-type="extras">
@@ -27,7 +27,7 @@ <h1 class="sidebar-projectName">
         Combination
       </h1>
       <h2 class="sidebar-projectVersion">
-        v0.0.1
+        v0.0.2
       </h2>
     </div>
 
@@ -62,7 +62,7 @@ <h1>Combination</h1>
 <p><a href="https://travis-ci.org/seantanly/elixir-combination"><img src="https://travis-ci.org/seantanly/elixir-combination.svg?branch=master" alt="Build Status"/></a>
 <a href="https://hex.pm/packages/combination"><img src="http://img.shields.io/hexpm/v/combination.svg?style=flat" alt="Hex.pm Version"/></a></p>
 <p>Elixir library to generate combinations and permutations from <code class="inline">Enumerable</code>.</p>
-<p>See <a href="#Examples">Examples</a>.</p>
+<p>See <a href="#examples">Examples</a>.</p>
 <h2 id="documentation"> Documentation</h2><p>API documentation is available at <a href="http://hexdocs.pm/combination"><a href="http://hexdocs.pm/combination">http://hexdocs.pm/combination</a></a></p>
 <h2 id="adding-combination-to-your-project"> Adding Combination To Your Project</h2><p>To use Combination with your projects, edit your <code class="inline">mix.exs</code> file and add it as a dependency:</p>
 <pre><code class="elixir">defp deps do
@@ -74,12 +74,6 @@ <h2 id="examples"> Examples</h2><p>To generate combinations,</p>
 <pre><code class="elixir">
 iex&gt; 1..3 |&gt; Combination.combine(2)
 [[3, 2], [3, 1], [2, 1]]
-
-iex&gt; 1..3 |&gt; Combination.combine(1..2)
-[[1], [2], [3], [3, 2], [3, 1], [2, 1]]
-
-iex&gt; 1..3 |&gt; Combination.combine(2..3)
-[[3, 2], [3, 1], [2, 1], [3, 2, 1]]
 </code></pre>
 <p>To generate permutations,</p>
 <pre><code class="elixir">
@@ -95,7 +89,7 @@ <h2 id="license"> LICENSE</h2><p>This software is licensed under <a href="LICENS
       <p>
         <span class="line">
           Built using
-          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.3),
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
         </span>
         <span class="line">
           designed by

diff --git a/mix.exs b/mix.exs
@@ -1,7 +1,7 @@
 defmodule Combination.Mixfile do
   use Mix.Project
 
-  @version "0.0.1"
+  @version "0.0.2"
 
   def project do
     [