[documentation] adding docstring to all the methods.

2016-08-11 16:13:53 +02:00
parent c72ed1e169
commit 36e7bc1bb2
3 changed files with 137 additions and 21 deletions
--- a/pylot/core/util/utils.py
+++ b/pylot/core/util/utils.py
@@ -223,10 +223,10 @@ def getPatternLine(fn, pattern):

 def isSorted(iterable):
    '''
-
-    :param iterable:
-    :type iterable:
-    :return:
+    Takes an iterable and checks if args* are in order.
+    :param iterable: any with defined __ls__() and __gs__()
+    :type iterable: list
+    :return: Boolean
    '''
    return sorted(iterable) == iterable