Merge pull request #18 from ekzhu/ekzhu-patch-1 for issue #17

Update documentations.

Author: ekzhu

SetSimilaritySearch/search.py

@@ -20,7 +20,9 @@ class SearchIndex(object):
 
     Args:
         sets (list): a list of sets, each entry is an iterable representing a
-            set.
+            set. Note, it is the caller's responsibility to ensure the elements
+            in each set are unique, and duplicate elements will cause incorrect
+            result.
         similarity_func_name (str): the name of the similarity function used;
             this function currently supports `"jaccard"`, `"cosine"`, and
             `"containment"`.
@@ -72,7 +74,7 @@ def query(self, s):
         """Query the search index for sets similar to the query set.
 
         Args:
-            s (Iterable): the query set.
+            s (Iterable): the query set with unique elements.
 
         Returns (list): a list of tuples `(index, similarity)` where the index
             is the index of the matching sets in the original list of sets.

setup.py

@@ -35,7 +35,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version="1.0.0",  # Required
+    version="1.0.1",  # Required
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#summary