add more details to block generator doc

usc-isi-i2 · Sep 5, 2018 · 732d80d · 732d80d
1 parent e5108da
commit 732d80d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/docs/mod_blocking.rst b/docs/mod_blocking.rst
@@ -1,6 +1,9 @@
 Blocking
 ========
 
+Block Generator
+---------------
+
 .. automodule:: rltk.blocking.block_generator
     :members:
     :special-members:
@@ -21,6 +24,9 @@ Blocking
     :special-members:
     :exclude-members: __dict__, __weakref__, __init__
 
+Blocking Helper
+---------------
+
 .. automodule:: rltk.blocking.blocking_helper
     :members:
     :special-members:

diff --git a/rltk/blocking/block_generator.py b/rltk/blocking/block_generator.py
@@ -24,7 +24,7 @@ def generate(self):
         Generate blocks (:meth:`_generate_blocks`) and return handler.
         
         Returns:
-            obj: Writer handler, which can be used by corresponding Reader.
+            obj: Block handler, which can be used by corresponding BlockReader.
             
         """
 

diff --git a/rltk/blocking/inverted_index_block_generator.py b/rltk/blocking/inverted_index_block_generator.py
@@ -26,6 +26,7 @@ class InvertedIndexBlockGenerator(BlockGenerator):
         
     
     Note:
+        This is a generic inverted index implementation which can be easily extended.
         If you use QGram as tokenizer, this becomes QGram block generator.
         
     Note: