From: John Sampson Date: 2013-01-01T23:29:41+09:00 Subject: Newbie question - gem documentation On 01/01/2013 14:04, tamouse mailing lists wrote: > On Tue, Jan 1, 2013 at 6:55 AM, John Sampson wrote: >> I am trying to understand how to find out how to use a gem that I have >> installed - >> specifically fuzzy-string-match. I have not been able to find a description >> - rdoc >> etc. are as easy to read as Sanskrit - is there an introduction to these >> mysteries >> for the newcomer anywhere? > Is the issue that you don't know how to call the methods (which the > documentation shows), or that you don't know what and how to implement > a fuzzy search? The gem is giving you the means to calculate > "distance" between two strings (the algorithm is named "Jaro-Winkler" > which is the measure of similarity between two strings, c.f. > https://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance), from > that you can choose how much "fuzziness" to apply, which can be highly > domain-specific. > > > The issue is that I don't know how to read the documentation. Where, or how, does it show how to call the methods? I would have thought there would be a general description somewhere explaining the structure of Github or Gem documentation. All I have found so far are disjointed fragments of code and some legalese. I only mention fuzzy-string-match as an example. It might be easier for me to write my own code based on theoretical descriptions of matching algorithms.