aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlexander Pickering <alexandermpickering@gmail.com>2016-06-27 19:12:53 -0400
committerAlexander Pickering <alexandermpickering@gmail.com>2016-06-27 19:12:53 -0400
commit88f89adfc551f05220c75a59e192e5f771aa3f82 (patch)
tree18f84b61395dab8ef1f315d491e60c22a3acf688 /doc
parent71692710e25cee2ffbda576629d63e75af59dc25 (diff)
downloadfuzzel-88f89adfc551f05220c75a59e192e5f771aa3f82.tar.gz
fuzzel-88f89adfc551f05220c75a59e192e5f771aa3f82.tar.bz2
fuzzel-88f89adfc551f05220c75a59e192e5f771aa3f82.zip
Finished useage examples for documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/config.ld4
-rw-r--r--doc/index.html74
2 files changed, 71 insertions, 7 deletions
diff --git a/doc/config.ld b/doc/config.ld
index e6121b8..eed8621 100644
--- a/doc/config.ld
+++ b/doc/config.ld
@@ -1,8 +1,8 @@
project = 'Fuzzel'
description = 'String matching library'
full_description = 'A few functions to do fuzzy string matching'
-title = 'Penlight Documentation'
+title = 'Fuzzel Documentation'
dir = 'doc'
use_markdown_titles = true
-format = 'markdown'
+format = 'discount'
file = '../src/fuzzel.lua'
diff --git a/doc/index.html b/doc/index.html
index d2fab8f..55fde7d 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -3,7 +3,7 @@
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
- <title>Penlight Documentation</title>
+ <title>Fuzzel Documentation</title>
<link rel="stylesheet" href="ldoc.css" type="text/css" />
</head>
<body>
@@ -112,7 +112,7 @@
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
<tr>
- <td class="name" nowrap><a href="#VERSION">VERSION</a></td>
+ <td class="name" nowrap><a href="#_VERSION">_VERSION</a></td>
<td class="summary">The current version (1.4).</td>
</tr>
</table>
@@ -165,6 +165,10 @@
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">fuzzel.LevenshteinDistance_extended(<span class="string">"juice"</span>,<span class="string">"moose"</span>,<span class="number">1</span>,<span class="number">2</span>,<span class="number">3</span>)</pre>
+ </ul>
</dd>
<dt>
@@ -196,6 +200,10 @@
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">fuzzel.LevenshteinDistance(<span class="string">"Flag"</span>,<span class="string">"Brag"</span>)</pre>
+ </ul>
</dd>
<dt>
@@ -226,6 +234,10 @@
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">fuzzel.LevenshteinRatio(<span class="string">"bling"</span>,<span class="string">"bring"</span>)</pre>
+ </ul>
</dd>
<dt>
@@ -273,6 +285,10 @@
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">DamerauLevenshteinDistance_extended(<span class="string">"berry"</span>,<span class="string">"bury"</span>,<span class="number">0</span>,<span class="number">1</span>,<span class="number">1</span>,<span class="number">2</span>,<span class="number">1</span>)</pre>
+ </ul>
</dd>
<dt>
@@ -303,6 +319,10 @@
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">fuzzel.DamerauLevenshteinDistance(<span class="string">"tree"</span>,<span class="string">"trap"</span>)</pre>
+ </ul>
</dd>
<dt>
@@ -333,6 +353,10 @@
+ <h3>Usage:</h3>
+ <ul>
+ <pre class="example">fuzzel.DamerauLevenshteinRatio(<span class="string">"pants"</span>,<span class="string">"hands"</span>)</pre>
+ </ul>
</dd>
<dt>
@@ -364,6 +388,11 @@
+ <h3>Usage:</h3>
+ <ul>
+ <li><pre class="example">fuzzel.HammingDistance(<span class="string">"one"</span>,<span class="string">"two"</span>)</pre></li>
+ <li><pre class="example">fuzzel.HammingDistance(<span class="string">"two"</span>,<span class="string">"three"</span>) --Will throw an error, since <span class="string">"two"</span> is <span class="number">3</span> characters long <span class="keyword">while</span> <span class="string">"three"</span> is <span class="number">5</span> characters long!</pre></li>
+ </ul>
</dd>
<dt>
@@ -394,6 +423,11 @@
+ <h3>Usage:</h3>
+ <ul>
+ <li><pre class="example">fuzzel.HammingRatio(<span class="string">"four"</span>,<span class="string">"five"</span>)</pre></li>
+ <li><pre class="example">fuzzel.HammingRatio(<span class="string">"seven"</span>,<span class="string">"ten"</span>) -- Will throw an error, since <span class="string">"seven"</span> is <span class="number">5</span> characters long <span class="keyword">while</span> <span class="string">"ten"</span> is <span class="number">3</span> characters long</pre></li>
+ </ul>
</dd>
<dt>
@@ -419,6 +453,11 @@
+ <h3>Usage:</h3>
+ <ul>
+ <li><pre class="example">fuzzel.FuzzyFindDistance(<span class="string">"tap"</span>,<span class="string">"tape"</span>,<span class="string">"strap"</span>,<span class="string">"tab"</span>)</pre></li>
+ <li><pre class="example">fuzzel.FuzzyFindDistance(<span class="string">"tap"</span>,{<span class="string">"tape"</span>,<span class="string">"strap"</span>,<span class="string">"tab"</span>})</pre></li>
+ </ul>
</dd>
<dt>
@@ -444,6 +483,11 @@
+ <h3>Usage:</h3>
+ <ul>
+ <li><pre class="example">fuzzel.FuzzyFindRatio(<span class="string">"light"</span>,{<span class="string">"lit"</span>,<span class="string">"lot"</span>,<span class="string">"lightbulb"</span>})</pre></li>
+ <li><pre class="example">fuzzel.FuzzyFindRatio(<span class="string">"light"</span>,<span class="string">"lit"</span>,<span class="string">"lot"</span>,<span class="string">"lightbulb"</span>)</pre></li>
+ </ul>
</dd>
<dt>
@@ -474,6 +518,11 @@
+ <h3>Usage:</h3>
+ <ul>
+ <li><pre class="example">fuzzel.FuzzySortDistance(<span class="string">"tub"</span>,{<span class="string">"toothpaste"</span>,<span class="string">"stub"</span>,<span class="string">"tube"</span>})</pre></li>
+ <li><pre class="example">fuzzel.FuzzySortDistance(<span class="string">"tub"</span>,<span class="string">"toothpaste"</span>,<span class="string">"stub"</span>,<span class="string">"tube"</span>)</pre></li>
+ </ul>
</dd>
<dt>
@@ -504,6 +553,11 @@
+ <h3>Usage:</h3>
+ <ul>
+ <li><pre class="example">fuzzel.FuzzySortRatio(<span class="string">"can"</span>,{<span class="string">"candle"</span>,<span class="string">"candie"</span>,<span class="string">"canister"</span>})</pre></li>
+ <li><pre class="example">fuzzel.FuzzySortRatio(<span class="string">"can"</span>,<span class="string">"candle"</span>,<span class="string">"candie"</span>,<span class="string">"canister"</span>)</pre></li>
+ </ul>
</dd>
<dt>
@@ -534,6 +588,11 @@
+ <h3>Usage:</h3>
+ <ul>
+ <li><pre class="example">fuzzel.FuzzyAutocompleteDistance(<span class="string">"brow"</span>,{<span class="string">"brown"</span>,<span class="string">"brownie"</span>,<span class="string">"high-brow"</span>})</pre></li>
+ <li><pre class="example">fuzzel.FuzzyAutocompleteDistance(<span class="string">"brow"</span>,<span class="string">"brown"</span>,<span class="string">"brownie"</span>,<span class="string">"high-brow"</span>)</pre></li>
+ </ul>
</dd>
<dt>
@@ -564,6 +623,11 @@
+ <h3>Usage:</h3>
+ <ul>
+ <li><pre class="example">fuzzel.FuzzyAutocompleteRatio(<span class="string">"egg"</span>,{<span class="string">"eggman"</span>,<span class="string">"excelent"</span>,<span class="string">"excaliber"</span>})</pre></li>
+ <li><pre class="example">fuzzel.FuzzyAutocompleteRatio(<span class="string">"egg"</span>,<span class="string">"eggman"</span>,<span class="string">"excelent"</span>,<span class="string">"excaliber"</span>)</pre></li>
+ </ul>
</dd>
</dl>
@@ -571,8 +635,8 @@
<dl class="function">
<dt>
- <a name = "VERSION"></a>
- <strong>VERSION</strong>
+ <a name = "_VERSION"></a>
+ <strong>_VERSION</strong>
</dt>
<dd>
The current version (1.4).
@@ -591,7 +655,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
-<i style="float:right;">Last updated 2016-06-27 18:24:14 </i>
+<i style="float:right;">Last updated 2016-06-27 19:11:33 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
generated by cgit v1.2.3-70-g09d2 (git 2.46.0) at 2026-01-18 06:53:41 +0000