Merge pull request #723 from PokhodenkoSA/docs-pandas-series

PokhodenkoSA · web-flow · commit f22b408cf59b · 2020-03-20T11:34:27.000+03:00
Docs for pandas.Series()
diff --git a/docs/source/buildscripts/sdc_object_utils.py b/docs/source/buildscripts/sdc_object_utils.py
@@ -69,7 +69,6 @@
     'sdc.hdist',
     'sdc.distributed_analysis',
     'sdc.hdatetime_ext',
-    'sdc.hiframes',
     'sdc.io.csv_ext',
     'sdc.hio',
     'sdc.hiframes.join',
diff --git a/sdc/hiframes/pd_series_ext.py b/sdc/hiframes/pd_series_ext.py
@@ -1046,6 +1046,27 @@ def typer(val1, val2):
 
 @overload(pd.Series)
 def pd_series_overload(data=None, index=None, dtype=None, name=None, copy=False, fastpath=False):
+    """
+    Intel Scalable Dataframe Compiler User Guide
+    ********************************************
+    Pandas API: pandas.Series
+
+    Limitations
+    -----------
+    - Parameters ``dtype`` and ``copy`` are currently unsupported by Intel Scalable Dataframe Compiler.
+    - Parameter ``dtype`` types iterable and dict are currently unsupported by Intel Scalable Dataframe Compiler.
+
+    Examples
+    --------
+    Create Series with data [1, 2, 3] and index ['A', 'B', 'C'].
+
+    >>> pd.Series([1, 2, 3], ['A', 'B', 'C'])
+
+    .. seealso::
+
+        :ref:`DataFrame <pandas.DataFrame>`
+            DataFrame constructor.
+    """
 
     is_index_none = isinstance(index, types.NoneType) or index is None
 
diff --git a/sdc/rewrites/dataframe_constructor.py b/sdc/rewrites/dataframe_constructor.py
@@ -160,32 +160,13 @@ def _replace_with_arrays(args, stmt, block, func_ir):
     @overload(DataFrame)
     def pd_dataframe_overload(data, index=None, columns=None, dtype=None, copy=False):
         """
-        Two-dimensional size-mutable, potentially heterogeneous tabular data
-        structure with labeled axes (rows and columns). Arithmetic operations
-        align on both row and column labels. Can be thought of as a dict-like
-        container for Series objects. The primary pandas data structure.
-
-        Parameters
-        ----------
-        data : dict
-            Dict can contain Series, arrays, constants, or list-like objects
-
-        index : array-like
-            Index to use for resulting frame. Will default to RangeIndex if
-            no indexing information part of input data and no index provided
-
-        columns : Index or array-like
-            Column labels to use for resulting frame. Will default to
-            RangeIndex (0, 1, 2, ..., n) if no column labels are provided
-            *unsupported*
-
-        dtype : dtype, default None
-            Data type to force. Only a single dtype is allowed. If None, infer
-            *unsupported*
-
-        copy : boolean, default False
-            Copy data from inputs. Only affects DataFrame / 2d ndarray input
-            *unsupported*
+        Intel Scalable Dataframe Compiler User Guide
+        ********************************************
+        Pandas API: pandas.DataFrame
+
+        Limitations
+        -----------
+        - Parameters `dtype` and `copy` are currently unsupported by Intel Scalable Dataframe Compiler.
         """
 
         ty_checker = TypeChecker('Method DataFrame')
