-

cool-RR · cool-RR · commit 420529531a27 · 2013-09-06T04:42:04.000+03:00
diff --git a/python_toolbox/cute_iter_tools.py b/python_toolbox/cute_iter_tools.py
@@ -202,17 +202,27 @@ def sentinel(counter=([fill_value] * (len(iterables) - 1)).pop):
         raise StopIteration
 
 
-def get_items(iterable, n, container=tuple):
+def get_items(iterable, n, container_type=tuple):
     '''
     Get the next `n` items from the iterable as a `tuple`.
     
     If there are less than `n` items, no exception will be raised. Whatever
     items are there will be returned.
+    
+    If you pass in a different kind of container than `tuple` as
+    `container_type`, it'll be used to wrap the results.
     '''
-    return container(shorten(iterable, n))
+    return container_type(shorten(iterable, n))
 
 
 def double_filter(filter_function, iterable):
+    '''
+    Filter an `iterable` into two lists according to a `filter_function`.
+    
+    This is similar to the builtin `filter`, except it returns a tuple of two
+    iterators, the first iterating on items that passed the filter function,
+    and the second iterating on items that didn't.
+    '''
     iterator = iter(iterable)
     
     true_deque = collections.deque()
diff --git a/python_toolbox/math_tools.py b/python_toolbox/math_tools.py
@@ -42,6 +42,12 @@ def ceil_div(x, y):
 
 
 def convert_to_base_in_tuple(number, base):
+    '''
+    Convert a number to any base, returning result in tuple.
+    
+    For example, `convert_to_base_in_tuple(32, base=10)` will be `(3, 2)` while
+    `convert_to_base_in_tuple(32, base=16)` will be `(2, 0)`.
+    '''
     assert isinstance(number, numbers.Integral)
     assert isinstance(base, numbers.Integral)
     assert base >= 2
@@ -60,6 +66,7 @@ def convert_to_base_in_tuple(number, base):
   
   
 def get_median(iterable):
+    '''Get the median of an iterable of numbers.'''
     sorted_values = sorted(iterable)
 
     if len(iterable) % 2 == 0:
@@ -73,6 +80,7 @@ def get_median(iterable):
     
     
 def get_mean(iterable):
+    '''Get the mean (average) of an iterable of numbers.'''
     sum_ = 0
     for i, value in enumerate(iterable):
         sum_ += value
