Fix documentation (#25)

Author: xadupre

_unittests/ut_df/test_dataframe_io_helpers.py

@@ -7,7 +7,8 @@
 from json import loads
 import pandas
 from pyquickhelper.pycode import ExtTestCase
-from pandas_streaming.df.dataframe_io_helpers import enumerate_json_items, JsonPerRowsStream
+from pandas_streaming.df.dataframe_io_helpers import (
+    enumerate_json_items, JsonPerRowsStream, JsonIterator2Stream)
 from pandas_streaming.df import StreamingDataFrame
 
 
@@ -253,6 +254,13 @@ def test_read_json_item(self):
             res.append(n)
         self.assertGreater(len(res), 1)
 
+    def test_bug_documentation(self):
+        items = []
+        for item in JsonIterator2Stream(
+                lambda: enumerate_json_items(TestDataFrameIOHelpers.text_json)):
+            items.append(item)
+        self.assertEqual(len(items), 2)
+
 
 if __name__ == "__main__":
     unittest.main()

pandas_streaming/df/dataframe.py

@@ -644,8 +644,9 @@ def concat(self, others, axis=0) -> 'StreamingDataFrame':
         Otherwise, the function fails as it cannot guess the schema without
         walking through all :epkg:`dataframes`.
 
-        @param  others      list, enumeration, :epkg:`pandas:DataFrame`
-        @return             @see cl StreamingDataFrame
+        :param others: list, enumeration, :epkg:`pandas:DataFrame`
+        :param axis: concatenate by rows (0) or by columns (1)
+        :return: @see cl StreamingDataFrame
         """
         if axis == 1:
             return self._concath(others)
@@ -1204,7 +1205,7 @@ def __del__(self):
 
 class StreamingSeries(StreamingDataFrame):
     """
-    Seens as a :epkg:`StreamingDataFrame` of one column.
+    Seens as a @see cl StreamingDataFrame of one column.
     """
 
     def __init__(self, iter_creation, check_schema=True, stable=True):

pandas_streaming/df/dataframe_io_helpers.py

@@ -391,8 +391,13 @@ class JsonIterator2Stream:
                 ]
             '''
 
-            for item in JsonIterator2Stream(enumerate_json_items(text_json)):
+            for item in JsonIterator2Stream(lambda: enumerate_json_items(text_json)):
                 print(item)
+
+    .. versionchanged:: 0.3
+        The class takes a function which outputs an iterator and not an iterator.
+        `JsonIterator2Stream(enumerate_json_items(text_json))` needs to be rewritten
+        into JsonIterator2Stream(lambda: enumerate_json_items(text_json)).
     """
 
     def __init__(self, it, **kwargs):