Skip to content

Commit 19aeeb4

Browse files
committed
updated docs
1 parent a9cf012 commit 19aeeb4

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

fuzzymatcher/data_getter_cartesian.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,17 @@
77
class DataGetterCartesian(DataGetterABC):
88

99
"""
10-
A DataGetter handles the retrieval of data from 'df_search_within'
11-
It retrieves lists of potential matches to a record in 'df_find_match_for'
12-
in 'df_search_within'
10+
The DataGetter class handles the retrieval of record_ids from 'df_right'
11+
12+
This Cartesian datagetter is the simplest, most thorough, but least efficient implementation
13+
where every record_id in 'df_right' is returned, compared and scored against 'df_left', leading to n^2 complexity.
14+
1315
"""
1416

1517
def add_data(self, matcher):
1618

17-
"""Adds the data in 'matcher.df_search_within' to a sqlite database
18-
and create a connection to the database to be used by the data getter
19-
Also registers the match object on the datagetter.
19+
"""
20+
Registers the matcher on the datagetter so the datagetter can manipulate the matcher object
2021
2122
Args:
2223
matcher. The matcher object
@@ -32,7 +33,7 @@ def get_potential_match_ids_from_record(self, rec_left):
3233
"""Retrieves lists of potential matches to a record
3334
3435
Args:
35-
rec_find_match_for: The record for which we're trying to find a match
36+
rec_left: The record for which we're trying to find a match
3637
3738
Returns:
3839
A list of rec_potential_match records which represent the potential matches

0 commit comments

Comments
 (0)