From 3e941b9ddc04df34422cf5f74ff219618dce4a64 Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 12 Apr 2016 17:49:46 -0400 Subject: [PATCH] Renamed package lev -> levenshtein --- NOTICE | 2 +- README.md | 8 ++++---- lev.go => levenshtein.go | 4 ++-- lev_test.go => levenshtein_test.go | 2 +- params.go | 2 +- params_test.go | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) rename lev.go => levenshtein.go (98%) rename lev_test.go => levenshtein_test.go (99%) diff --git a/NOTICE b/NOTICE index 93bbe10..eaffaab 100644 --- a/NOTICE +++ b/NOTICE @@ -1,4 +1,4 @@ -Alrux Go EXTensions (AGExt) - package lev +Alrux Go EXTensions (AGExt) - package levenshtein Copyright 2016 ALRUX Inc. This product includes software developed at ALRUX Inc. diff --git a/README.md b/README.md index 33a9657..e3e9b78 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,13 @@ This package implements distance and similarity metrics for strings, based on th ## Maturity -[![Build Status](https://travis-ci.org/agext/lev.svg?branch=master)](https://travis-ci.org/agext/lev) +[![Build Status](https://travis-ci.org/agext/levenshtein.svg?branch=master)](https://travis-ci.org/agext/levenshtein) v1.1 Stable: Guaranteed no breaking changes to the API in future v1.x releases. No known bugs or performance issues. Probably safe to use in production, though provided on "AS IS" basis. ## Overview -[![GoDoc](https://godoc.org/github.com/agext/lev?status.png)](https://godoc.org/github.com/agext/lev) +[![GoDoc](https://godoc.org/github.com/agext/levenshtein?status.png)](https://godoc.org/github.com/agext/levenshtein) The Levenshtein `Distance` between two strings is the minimum total cost of edits that would convert the first string into the second. The allowed edit operations are insertions, deletions, and substitutions, all at character (one UTF-8 code point) level. Each operation has a default cost of 1, but each can be assigned its own cost equal to or greater than 0. @@ -25,9 +25,9 @@ The underlying `Calculate` function is also exported, to allow the building of o ## Installation ``` -go get github.com/agext/lev +go get github.com/agext/levenshtein ``` ## License -Package lev is released under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. +Package levenshtein is released under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. diff --git a/lev.go b/levenshtein.go similarity index 98% rename from lev.go rename to levenshtein.go index 3ad5b72..69ca17d 100644 --- a/lev.go +++ b/levenshtein.go @@ -13,7 +13,7 @@ // limitations under the License. /* -Package lev implements distance and similarity metrics for strings, based on the Levenshtein measure. +Package levenshtein implements distance and similarity metrics for strings, based on the Levenshtein measure. The Levenshtein `Distance` between two strings is the minimum total cost of edits that would convert the first string into the second. The allowed edit operations are insertions, deletions, and substitutions, all at character (one UTF-8 code point) level. Each operation has a default cost of 1, but each can be assigned its own cost equal to or greater than 0. @@ -25,7 +25,7 @@ The `Match` function provides a similarity metric, with the same range and meani The underlying `Calculate` function is also exported, to allow the building of other derivative metrics, if needed. */ -package lev +package levenshtein // Calculate determines the Levenshtein distance between two strings, using // the given costs for each edit operation. It returns the distance along with diff --git a/lev_test.go b/levenshtein_test.go similarity index 99% rename from lev_test.go rename to levenshtein_test.go index a2991da..c544e88 100644 --- a/lev_test.go +++ b/levenshtein_test.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package lev +package levenshtein import ( "testing" diff --git a/params.go b/params.go index 04aee8c..e752475 100644 --- a/params.go +++ b/params.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package lev +package levenshtein // Params represents a set of parameter values for the various formulas involved // in the calculation of the Levenshtein string metrics. diff --git a/params_test.go b/params_test.go index 9cbfbce..5b21291 100644 --- a/params_test.go +++ b/params_test.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package lev +package levenshtein import ( "testing"