Skip to content

Commit

Permalink
Add some text to describe the similar_score method on the README
Browse files Browse the repository at this point in the history
  • Loading branch information
dshorthouse committed Sep 29, 2024
1 parent 0326a2c commit b475f72
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ else
end
```

There's also a similarity score to compare the structure of two given names. The greater the score, the more likely aliases refer to the "same" name. For instance, "John C." scores a 2 when compared to "John Charles", a 1.1 when compared to "John" alone whereas it scores a 0 when compared to "Joshua" or "John R.". Given two names that share the same family name, this utility method could be used to down-weight search results if the given name portions are unlikely matches.
There's also a similarity score to compare the structure of two given names. The greater the score, the more likely aliases refer to the "same" name. For instance, "John C." scores a 2 when compared to "John Charles", a 1.1 when compared to "John" alone whereas it scores a 0 when compared to "Joshua" or "John R.". If two names share the same family name, this utility method could be used to down-weight search results if the given name portions of the names are unlikely matches.

```ruby
require "dwc_agent"
Expand Down

0 comments on commit b475f72

Please sign in to comment.