Skip to content

Commit

Permalink
Add threshold None and label docstrings for String (#189)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidggphy authored May 20, 2023
1 parent 23e67d5 commit 2d93cf9
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion recordlinkage/compare.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,15 @@ class String(BaseCompareFeature):
An approximate string comparison method. Options are ['jaro',
'jarowinkler', 'levenshtein', 'damerau_levenshtein', 'qgram',
'cosine', 'smith_waterman', 'lcs']. Default: 'levenshtein'
threshold : float, tuple of floats
threshold : None, float, tuple of floats
A threshold value. All approximate string comparisons higher or
equal than this threshold are 1. Otherwise 0.
If None, it returns the float string comparison value instead of 0 or 1.
Default None.
missing_value : numpy.dtype
The value for a comparison with a missing value. Default 0.
label : list, str, int
The identifying label(s) for the returned values. Default None.
"""

name = "string"
Expand Down

0 comments on commit 2d93cf9

Please sign in to comment.