Rooba
/
RapidFuzz
mirror of https://github.com/maxbachmann/RapidFuzz.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

document: update return value of extract and extractOne methods

This commit is contained in:
TrigonaMinima 2020-05-30 20:33:13 +05:30
parent 5ce2172b13
commit 14b4102506
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/rapidfuzz/process.py
View File

@ -78,7 +78,10 @@ def extract(query: str, choices: Iterable, scorer: Callable = fuzz.WRatio, proce
a lower score than this number will not be returned. Defaults to 0
Returns:
List[Tuple[str, float]]: returns a list of all matches that have a score >= score_cutoff
Union[List[Tuple[str, float]], List[Tuple[str, float, str]]]: Returns a
list of all matches that have a `score >= score_cutoff`. The list will
be of either `(, )` when `choices` is a list of strings or `(, , )` when
`choices` is a mapping.
"""
results = iterExtract(query, choices, scorer, processor, score_cutoff)