aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Czygan <martin.czygan@gmail.com>2020-12-17 02:28:19 +0100
committerMartin Czygan <martin.czygan@gmail.com>2020-12-17 02:28:19 +0100
commit490e1cd1aa776fba356c1273310452d047db25cc (patch)
tree8b5d827b36bfcb9f98f86d8e1d247b3b2591cae7
parente575e8e42aa74fc5677dc73a075f3856fdb2f6c7 (diff)
downloadfuzzycat-490e1cd1aa776fba356c1273310452d047db25cc.tar.gz
fuzzycat-490e1cd1aa776fba356c1273310452d047db25cc.zip
update docs
-rw-r--r--fuzzycat/__main__.py1
-rw-r--r--fuzzycat/verify.py11
2 files changed, 4 insertions, 8 deletions
diff --git a/fuzzycat/__main__.py b/fuzzycat/__main__.py
index ab1727b..d9dbe9a 100644
--- a/fuzzycat/__main__.py
+++ b/fuzzycat/__main__.py
@@ -194,6 +194,7 @@ if __name__ == '__main__':
format='%(asctime)s.%(msecs)03d %(levelname)s %(module)s - %(funcName)s: %(message)s',
datefmt='%Y-%m-%d %H:%M:%S')
+ # TODO: group flags sensibly
parser = argparse.ArgumentParser(prog='fuzzycat',
description=__doc__,
usage='%(prog)s command [options]',
diff --git a/fuzzycat/verify.py b/fuzzycat/verify.py
index e9bbde9..6b0a448 100644
--- a/fuzzycat/verify.py
+++ b/fuzzycat/verify.py
@@ -97,14 +97,9 @@ Verify = collections.namedtuple("Verify", "status reason")
class GroupVerifier:
"""
- Verifier.
-
- Within a group, we could have multiple sub clusters, e.g.
-
- > [AABAB]
-
- We would need to compare each possible pair and decide whether they are the
- same.
+ Given an iterable (lines) from clustering step, run verification on every
+ pair of the cluster, e.g. a cluster of four elements will yield nCr(4, 2) =
+ 10 pairs.
"""
def __init__(self,
iterable: collections.abc.Iterable,