Add documentation

alemazzo · alemazzo · commit af51ee3d34f2 · 2021-03-06T22:14:28.000+01:00
diff --git a/stream/numbers.py b/stream/numbers.py
@@ -79,11 +79,23 @@ def random():
 
     @staticmethod
     def range(start, end, step=1):
+        '''
+        Returns a stream of numbers from start to end with specified step.
+
+        :param int start: the start value
+        :param int end: the max value
+        :param int step: the step
+        :return: the new stream
+        '''
         return NumberStream(Stream.iterate(start, lambda i: i + step).takeWhile(lambda x: x <= end))
 
     @staticmethod
     def pi():
+        '''
+        Returns a stream with the digits of PI.
 
+        :return: the PI's digits stream
+        '''
         def pi_digits():
             "Generate n digits of Pi."
             k, a, b, a1, b1 = 2, 4, 1, 12, 4
@@ -105,6 +117,11 @@ def __init__(self, _stream):
             self.iterable = _stream
 
     def average(self):
+        '''
+        Get the average value of the element of the stream.
+
+        :return: the average value
+        '''
         _sum = 0
         _count = 0
         for elem in self:
diff --git a/stream/stream.py b/stream/stream.py
@@ -99,13 +99,14 @@ def concat(*streams):
 
     @staticmethod
     def constant(element):
+        '''
+        Return an infinite sequential stream where each element is the passed element
 
+        :param T elem: the element
+        :return: the new stream made of @element
+        '''
         return Stream.generate(lambda: element)
 
-    @staticmethod
-    def booleans():
-        return Stream.generate(lambda: random.randint(0, 1) == 1)
-
     """
     Normal Methods
     """
