Penlight Documentation

From 88f89adfc551f05220c75a59e192e5f771aa3f82 Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Mon, 27 Jun 2016 19:12:53 -0400 Subject: Finished useage examples for documentation --- doc/config.ld | 4 ++-- doc/index.html | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 71 insertions(+), 7 deletions(-) (limited to 'doc') 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 @@ - Penlight Documentation + Fuzzel Documentation @@ -112,7 +112,7 @@

Fields

- +

VERSION

_VERSION

The current version (1.4).

@@ -165,6 +165,10 @@ +

Usage:

fuzzel.LevenshteinDistance_extended("juice","moose",1,2,3)

@@ -196,6 +200,10 @@ +

Usage:

fuzzel.LevenshteinDistance("Flag","Brag")

@@ -226,6 +234,10 @@ +

Usage:

fuzzel.LevenshteinRatio("bling","bring")

@@ -273,6 +285,10 @@ +

Usage:

DamerauLevenshteinDistance_extended("berry","bury",0,1,1,2,1)

@@ -303,6 +319,10 @@ +

Usage:

fuzzel.DamerauLevenshteinDistance("tree","trap")

@@ -333,6 +353,10 @@ +

Usage:

fuzzel.DamerauLevenshteinRatio("pants","hands")

@@ -364,6 +388,11 @@ +

Usage:

```
fuzzel.HammingDistance("one","two")
```

fuzzel.HammingDistance("two","three") --Will throw an error, since "two" is 3 characters long while "three" is 5 characters long!

@@ -394,6 +423,11 @@ +

Usage:

```
fuzzel.HammingRatio("four","five")
```

fuzzel.HammingRatio("seven","ten") -- Will throw an error, since "seven" is 5 characters long while "ten" is 3 characters long

@@ -419,6 +453,11 @@ +

Usage:

fuzzel.FuzzyFindDistance("tap","tape","strap","tab")

fuzzel.FuzzyFindDistance("tap",{"tape","strap","tab"})

@@ -444,6 +483,11 @@ +

Usage:

fuzzel.FuzzyFindRatio("light",{"lit","lot","lightbulb"})

fuzzel.FuzzyFindRatio("light","lit","lot","lightbulb")

@@ -474,6 +518,11 @@ +

Usage:

fuzzel.FuzzySortDistance("tub",{"toothpaste","stub","tube"})

fuzzel.FuzzySortDistance("tub","toothpaste","stub","tube")

@@ -504,6 +553,11 @@ +

Usage:

fuzzel.FuzzySortRatio("can",{"candle","candie","canister"})

fuzzel.FuzzySortRatio("can","candle","candie","canister")

@@ -534,6 +588,11 @@ +

Usage:

fuzzel.FuzzyAutocompleteDistance("brow",{"brown","brownie","high-brow"})

fuzzel.FuzzyAutocompleteDistance("brow","brown","brownie","high-brow")

@@ -564,6 +623,11 @@ +

Usage:

fuzzel.FuzzyAutocompleteRatio("egg",{"eggman","excelent","excaliber"})

fuzzel.FuzzyAutocompleteRatio("egg","eggman","excelent","excaliber")

@@ -571,8 +635,8 @@

- - VERSION + + _VERSION: The current version (1.4). @@ -591,7 +655,7 @@
generated by LDoc 1.4.3 -Last updated 2016-06-27 18:24:14 +Last updated 2016-06-27 19:11:33
-- cgit v1.2.3-70-g09d2