correct doc for Series.setitem (#742)

Rubtsowa · web-flow · commit 2facf7988226 · 2020-03-20T14:32:10.000+03:00
diff --git a/docs/source/_templates/_api_ref.pandas.series_templ.rst b/docs/source/_templates/_api_ref.pandas.series_templ.rst
@@ -33,6 +33,7 @@ Attributes/Operators
    Series.dtypes
    Series.name
    Series.put
+   Series.setitem
 
 Type Conversions
 ----------------
diff --git a/docs/source/api_ref/pandas.Series.setitem.rst b/docs/source/api_ref/pandas.Series.setitem.rst
diff --git a/sdc/datatypes/hpat_pandas_series_functions.py b/sdc/datatypes/hpat_pandas_series_functions.py
@@ -462,14 +462,16 @@ def sdc_pandas_series_setitem(self, idx, value):
     """
     Intel Scalable Dataframe Compiler User Guide
     ********************************************
-    Pandas API: pandas.Series.__setitem__
+    Pandas API: pandas.Series.setitem
+
+    Set value to Series by index
 
     Limitations
     -----------
-        Not supported for idx as a string slice, e.g. S['a':'f'] = value
-        Not supported for string series
-        Not supported for a case of setting value for non existing index
-        Not supported for cases when setting causes change of the Series dtype
+       - Not supported for idx as a string slice, e.g. S['a':'f'] = value
+       - Not supported for string series
+       - Not supported for a case of setting value for non existing index
+       - Not supported for cases when setting causes change of the Series dtype
 
     Examples
     --------
@@ -479,34 +481,50 @@ def sdc_pandas_series_setitem(self, idx, value):
        :caption: Setting Pandas Series elements
        :name: ex_series_setitem
 
-    .. code-block:: console
-
-        > python ./series/series_setitem_int.py
+    .. command-output:: python ./series/series_setitem_int.py
+       :cwd: ../../../examples
 
-            0    0
-            1    4
-            2    3
-            3    2
-            4    1
-            dtype: int64
+    .. literalinclude:: ../../../examples/series/series_setitem_slice.py
+       :language: python
+       :lines: 27-
+       :caption: Setting Pandas Series elements by slice
+       :name: ex_series_setitem
 
-        > python ./series/series_setitem_slice.py
+    .. command-output:: python ./series/series_setitem_slice.py
+       :cwd: ../../../examples
 
-            0    5
-            1    4
-            2    0
-            3    0
-            4    0
-            dtype: int64
+    .. literalinclude:: ../../../examples/series/series_setitem_series.py
+       :language: python
+       :lines: 27-
+       :caption: Setting Pandas Series elements by series
+       :name: ex_series_setitem
 
-        > python ./series/series_setitem_series.py
+    .. command-output:: python ./series/series_setitem_series.py
+       :cwd: ../../../examples
 
-            0    5
-            1    0
-            2    3
-            3    0
-            4    1
-            dtype: int64
+    .. seealso::
+            :ref:`Series.getitem <pandas.Series.getitem>`
+                Get value(s) of Series by key.
+            :ref:`Series.loc <pandas.Series.loc>`
+                Access a group of rows and columns by label(s) or a boolean array.
+            :ref:`Series.iloc <pandas.Series.iloc>`
+                Purely integer-location based indexing for selection by position.
+            :ref:`Series.at <pandas.Series.at>`
+                Access a single value for a row/column label pair.
+            :ref:`Series.iat <pandas.Series.iat>`
+                Access a single value for a row/column pair by integer position.
+            :ref:`DataFrame.getitem <pandas.DataFrame.getitem>`
+                Get data from a DataFrame by indexer.
+            :ref:`DataFrame.setitem <pandas.DataFrame.setitem>`
+                Set value to DataFrame by index
+            :ref:`DataFrame.loc <pandas.DataFrame.loc>`
+                Access a group of rows and columns by label(s) or a boolean array.
+            :ref:`DataFrame.iloc <pandas.DataFrame.iloc>`
+                Purely integer-location based indexing for selection by position.
+            :ref:`DataFrame.at <pandas.DataFrame.at>`
+                Access a single value for a row/column label pair.
+            :ref:`DataFrame.iat <pandas.DataFrame.iat>`
+                Access a single value for a row/column pair by integer position.
 
     Intel Scalable Dataframe Compiler Developer Guide
     *************************************************
