aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2020-12-14 20:39:31 +0100
committerMartin Czygan <martin.czygan@gmail.com>2020-12-14 20:39:31 +0100
commit461280538c96cfbbff7a85ab32fb162909fe64f7 (patch)
tree714181d082616bb811619aac81d27c3448f8d0fd
parent54a5fc7f3fa6893a83143a1755aa6b4497efa33c (diff)
downloadfuzzycat-461280538c96cfbbff7a85ab32fb162909fe64f7.tar.gz
fuzzycat-461280538c96cfbbff7a85ab32fb162909fe64f7.zip
update docs
-rw-r--r--fuzzycat/verify.py7
1 files changed, 7 insertions, 0 deletions
diff --git a/fuzzycat/verify.py b/fuzzycat/verify.py
index 9fcd62e..93b9f1d 100644
--- a/fuzzycat/verify.py
+++ b/fuzzycat/verify.py
@@ -151,6 +151,13 @@ class GroupVerifier:
def verify(a: Dict, b: Dict, min_title_length=5) -> Tuple[str, str]:
"""
Compare two entities (dicts), return tuple of match status and reason.
+
+ Note: This is a too long function, but tested so open to near-term
+ refactor. On the plus, it is uniform in the sense, that a few lines take
+ care of a specific case.
+
+ The cases are relatively independent, so order should not matter, but that
+ can be pinned down much more clearly.
"""
# A few items have the same DOI.