update doc for sorted neighbourhood

usc-isi-i2 · Oct 2, 2019 · 31a1fa9 · 31a1fa9
1 parent 0cc26cb
commit 31a1fa9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/mod_blocking.rst b/docs/mod_blocking.rst
@@ -36,6 +36,11 @@ Block Generator
     :special-members:
     :exclude-members: __dict__, __weakref__, __init__
 
+.. automodule:: rltk.blocking.sorted_neighbourhood_block_generator
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
 .. automodule:: rltk.blocking.canopy_block_generator
     :members:
     :special-members:

diff --git a/rltk/blocking/sorted_neighbourhood_block_generator.py b/rltk/blocking/sorted_neighbourhood_block_generator.py
@@ -16,6 +16,7 @@ class SortedNeighbourhoodBlockGenerator(BlockGenerator):
                             The signature is `comparator(t1: str, t2: str) -> int`.
                             If return is 0, t1 equals t2; if return is -1, t1 is less than t2;
                             if return is 1, t1 is greater than t2.
+                            Defaults to None, which uses Python's default string comparison.
         block_id_prefix (str): The block id prefix of each block.
     """
     def __init__(self, window_size: int = 3, comparator: Callable = None, block_id_prefix='sorted_neighbourhood_'):