correct doc for Series.lt (#770)

Author: Rubtsowa

sdc/datatypes/hpat_pandas_series_functions.py

@@ -2512,7 +2512,8 @@ def hpat_pandas_series_ne(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -2525,10 +2526,6 @@ def hpat_pandas_series_ne(self, other, level=None, fill_value=None, axis=0):
     .. command-output:: python ./series/series_ne.py
        :cwd: ../../../examples
 
-    .. note::
-
-        Parameter axis is currently unsupported by Intel Scalable Dataframe Compiler
-
     Intel Scalable Dataframe Compiler Developer Guide
     *************************************************
     Pandas Series method :meth:`pandas.Series.ne` implementation.
@@ -2576,7 +2573,8 @@ def hpat_pandas_series_add(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    Parameters ``level``, ``fill_value`` and ``axis`` are unsupported.
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``
 
     Examples
     --------
@@ -2639,7 +2637,8 @@ def hpat_pandas_series_sub(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -2652,10 +2651,6 @@ def hpat_pandas_series_sub(self, other, level=None, fill_value=None, axis=0):
     .. command-output:: python ./series/series_sub.py
        :cwd: ../../../examples
 
-    .. note::
-
-        Parameter axis is currently unsupported by Intel Scalable Dataframe Compiler
-
     .. seealso::
 
         :ref:`Series.rsub <pandas.Series.rsub>`
@@ -2986,7 +2981,8 @@ def hpat_pandas_series_mul(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    Parameters ``level``, ``fill_value`` and ``axis`` are currently unsupported.
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -3057,7 +3053,8 @@ def hpat_pandas_series_div(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    Parameters ``level``, ``fill_value`` and ``axis`` are unsupported.
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -3129,7 +3126,8 @@ def hpat_pandas_series_truediv(self, other, level=None, fill_value=None, axis=0)
 
     Limitations
     -----------
-    Parameters ``level``, ``fill_value`` and ``axis`` are currently unsupported.
+    * Parameter ``axis`` is c
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -3201,7 +3199,8 @@ def hpat_pandas_series_floordiv(self, other, level=None, fill_value=None, axis=0
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -3214,10 +3213,6 @@ def hpat_pandas_series_floordiv(self, other, level=None, fill_value=None, axis=0
     .. command-output:: python ./series/series_floordiv.py
        :cwd: ../../../examples
 
-    .. note::
-
-        Parameter axis is currently unsupported by Intel Scalable Dataframe Compiler
-
     .. seealso::
 
         :ref:`Series.rfloordiv <pandas.Series.rfloordiv>`
@@ -3269,7 +3264,8 @@ def hpat_pandas_series_pow(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -3779,7 +3775,8 @@ def hpat_pandas_series_mod(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -3792,10 +3789,6 @@ def hpat_pandas_series_mod(self, other, level=None, fill_value=None, axis=0):
     .. command-output:: python ./series/series_mod.py
        :cwd: ../../../examples
 
-    .. note::
-
-        Parameter axis is currently unsupported by Intel Scalable Dataframe Compiler
-
     Intel Scalable Dataframe Compiler Developer Guide
     *************************************************
     Pandas Series method :meth:`pandas.Series.mod` implementation.
@@ -3843,7 +3836,8 @@ def hpat_pandas_series_eq(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -3856,10 +3850,6 @@ def hpat_pandas_series_eq(self, other, level=None, fill_value=None, axis=0):
     .. command-output:: python ./series/series_mod.py
        :cwd: ../../../examples
 
-    .. note::
-
-        Parameter axis is currently unsupported by Intel Scalable Dataframe Compiler
-
     Intel Scalable Dataframe Compiler Developer Guide
     *************************************************
     Pandas Series method :meth:`pandas.Series.eq` implementation.
@@ -3907,7 +3897,8 @@ def hpat_pandas_series_ge(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -4066,7 +4057,8 @@ def hpat_pandas_series_lt(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -4079,10 +4071,6 @@ def hpat_pandas_series_lt(self, other, level=None, fill_value=None, axis=0):
     .. command-output:: python ./series/series_lt.py
        :cwd: ../../../examples
 
-    .. note::
-
-        Parameter axis is currently unsupported by Intel Scalable Dataframe Compiler
-
     Intel Scalable Dataframe Compiler Developer Guide
     *************************************************
     Pandas Series method :meth:`pandas.Series.lt` implementation.
@@ -4130,7 +4118,8 @@ def hpat_pandas_series_gt(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -4143,10 +4132,6 @@ def hpat_pandas_series_gt(self, other, level=None, fill_value=None, axis=0):
     .. command-output:: python ./series/series_gt.py
        :cwd: ../../../examples
 
-    .. note::
-
-        Parameter axis is currently unsupported by Intel Scalable Dataframe Compiler
-
     Intel Scalable Dataframe Compiler Developer Guide
     *************************************************
     Pandas Series method :meth:`pandas.Series.gt` implementation.
@@ -4194,7 +4179,8 @@ def hpat_pandas_series_le(self, other, level=None, fill_value=None, axis=0):
 
     Limitations
     -----------
-    - Parameters level, fill_value are currently unsupported by Intel Scalable Dataframe Compiler
+    * Parameter ``axis`` is supported only with default value ``0``.
+    * Parameters ``level`` and ``fill_value`` are supported only with default value ``None``.
 
     Examples
     --------
@@ -4207,10 +4193,6 @@ def hpat_pandas_series_le(self, other, level=None, fill_value=None, axis=0):
     .. command-output:: python ./series/series_le.py
        :cwd: ../../../examples
 
-    .. note::
-
-        Parameter axis is currently unsupported by Intel Scalable Dataframe Compiler
-
     Intel Scalable Dataframe Compiler Developer Guide
     *************************************************
     Pandas Series method :meth:`pandas.Series.le` implementation.