diff options
author | Rocky Madden <git@rockymadden.com> | 2013-03-10 10:49:46 -0600 |
---|---|---|
committer | Rocky Madden <git@rockymadden.com> | 2013-03-10 10:49:46 -0600 |
commit | b5885ff2aaa3a0509a03c08e790f7e2299ea6bf6 (patch) | |
tree | d28eb172a7a0bd6c8e7bb41ffba84ab644a2fbfe | |
parent | 438de052258b62b71b1a4b6e379325f4c94c85cb (diff) | |
download | stringmetric-b5885ff2aaa3a0509a03c08e790f7e2299ea6bf6.tar.gz stringmetric-b5885ff2aaa3a0509a03c08e790f7e2299ea6bf6.tar.bz2 stringmetric-b5885ff2aaa3a0509a03c08e790f7e2299ea6bf6.zip |
Cleaned up convenience comments.
-rwxr-xr-x | readme.md | 10 |
1 files changed, 4 insertions, 6 deletions
@@ -373,11 +373,9 @@ Basic example with stacked filter. Filters are applied in reverse order: ## Convenience objects Convenience objects are available to make interactions with the library easier. ---- - __StringAlgorithm:__ ```scala -// Invoke compute methods. Each algorithm backed by an undecorated lazy val. +// Easy access to compute methods. StringAlgorithm.computeWithMetaphone("string") // Easy access to types and companion objects. @@ -388,7 +386,7 @@ val metaphone: StringAlgorithm.MetaphoneAlgorithm = StringAlgorithm.MetaphoneAlg __StringMetric:__ ```scala -// Invoke compare methods. Each metric backed by an undecorated lazy val. +// Easy access to compare methods. StringMetric.compareWithJaroWinkler("string1", "string2") // Easy access to types and companion objects. @@ -408,7 +406,7 @@ val asciiSpace: StringFilter.AsciiSpaceStringFilter = StringFilter.asciiControl __ConfigurableStringAlgorithm:__ ```scala -// Invoke compute methods. Each algorithm backed by an undecorated lazy val. +// Easy access to compute methods. ConfigurableStringAlgorithm.computeWithNGram("string")(2) // Easy access to types and companion objects. @@ -419,7 +417,7 @@ val nGram: ConfigurableStringAlgorithm.NGramAlgorithm: = ConfigurableStringAlgor __ConfigurableStringMetric:__ ```scala -// Invoke compute methods. Each algorithm backed by an undecorated lazy val. +// Easy access to compare methods. ConfigurableStringMetric.compareWithDiceSorensen("string1", "string2")(2) // Easy access to types and companion objects. |