+ comments to flatten_samplesets

bob/pipelines/utils.py

@@ -97,6 +97,17 @@ def hash_string(key, bucket_size=1000):
 
 
 def flatten_samplesets(samplesets):
+    """
+    Takes a list of SampleSets (with one or multiple samples in each SampleSet)
+    and returns a list of SampleSets (with one sample in each SampleSet)
+
+    Parameters
+    ----------
+
+    samplesets: list of SampleSets
+      Input list of SampleSets (with one or multiple samples in each SampleSet
+
+    """
     new_samplesets = []
 
     # Iterating over the samplesets