DOC: Update Sphinx Deprecated Directive

doc/source/io.rst

@@ -137,8 +137,9 @@ usecols : array-like or callable, default ``None``
 
   Using this parameter results in much faster parsing time and lower memory usage.
 as_recarray : boolean, default ``False``
-  DEPRECATED: this argument will be removed in a future version. Please call
-  ``pd.read_csv(...).to_records()`` instead.
+  .. deprecated:: 0.18.2
+     This argument will be removed in a future version. Please call
+     ``pd.read_csv(...).to_records()`` instead.
 
   Return a NumPy recarray instead of a DataFrame after parsing the data. If
   set to ``True``, this option takes precedence over the ``squeeze`` parameter.
@@ -191,7 +192,8 @@ skiprows : list-like or integer, default ``None``
 skipfooter : int, default ``0``
   Number of lines at bottom of file to skip (unsupported with engine='c').
 skip_footer : int, default ``0``
-  DEPRECATED: use the ``skipfooter`` parameter instead, as they are identical
+  .. deprecated:: 0.19.0
+     Use the ``skipfooter`` parameter instead, as they are identical
 nrows : int, default ``None``
   Number of rows of file to read. Useful for reading pieces of large files.
 low_memory : boolean, default ``True``
@@ -202,16 +204,19 @@ low_memory : boolean, default ``True``
   use the ``chunksize`` or ``iterator`` parameter to return the data in chunks.
   (Only valid with C parser)
 buffer_lines : int, default None
-    DEPRECATED: this argument will be removed in a future version because its
-    value is not respected by the parser
+  .. deprecated:: 0.18.2
+     This argument will be removed in a future version because its
+     value is not respected by the parser
 compact_ints : boolean, default False
+  .. deprecated:: 0.18.2
   DEPRECATED: this argument will be removed in a future version
 
   If ``compact_ints`` is ``True``, then for any column that is of integer dtype, the
   parser will attempt to cast it as the smallest integer ``dtype`` possible, either
   signed or unsigned depending on the specification from the ``use_unsigned`` parameter.
 use_unsigned : boolean, default False
-  DEPRECATED: this argument will be removed in a future version
+  .. deprecated:: 0.18.2
+     This argument will be removed in a future version
 
   If integer columns are being compacted (i.e. ``compact_ints=True``), specify whether
   the column should be compacted to the smallest signed or unsigned integer dtype.

doc/sphinxext/numpydoc/README.rst

@@ -46,6 +46,8 @@ The following options can be set in conf.py:
   methods and attributes. If a table of contents is made, Sphinx expects
   each entry to have a separate page.
 
-- numpydoc_edit_link: bool  (DEPRECATED -- edit your HTML template instead)
+- numpydoc_edit_link: bool
+    .. deprecated::
+       Edit your HTML template instead
 
   Whether to insert an edit link after docstrings.

pandas/_libs/tslib.pyx

@@ -1148,7 +1148,8 @@ cdef class _Timestamp(datetime):
 
     cpdef datetime to_datetime(_Timestamp self):
         """
-        DEPRECATED: use :meth:`to_pydatetime` instead.
+        .. deprecated:: 0.19.0
+           Use :meth:`to_pydatetime` instead.
 
         Convert a Timestamp object to a native Python datetime object.
         """

pandas/core/categorical.py

@@ -391,8 +391,8 @@ def itemsize(self):
 
     def reshape(self, new_shape, *args, **kwargs):
         """
-        DEPRECATED: calling this method will raise an error in a
-        future release.
+        .. deprecated:: 0.19.0
+           Calling this method will raise an error in a future release.
 
         An ndarray-compatible method that returns `self` because
         `Categorical` instances cannot actually be reshaped.
@@ -423,7 +423,8 @@ def base(self):
     @classmethod
     def from_array(cls, data, **kwargs):
         """
-        DEPRECATED: Use ``Categorical`` instead.
+        .. deprecated::
+           Use ``Categorical`` instead.
 
         Make a Categorical type from a single array-like object.
 
@@ -1442,8 +1443,9 @@ def _values_for_rank(self):
 
     def order(self, inplace=False, ascending=True, na_position='last'):
         """
-        DEPRECATED: use :meth:`Categorical.sort_values`. That function
-        is entirely equivalent to this one.
+        .. deprecated:: 0.18.1
+           Use :meth:`Categorical.sort_values`. That function
+           is entirely equivalent to this one.
 
         See Also
         --------
@@ -1456,10 +1458,11 @@ def order(self, inplace=False, ascending=True, na_position='last'):
 
     def sort(self, inplace=True, ascending=True, na_position='last', **kwargs):
         """
-        DEPRECATED: use :meth:`Categorical.sort_values`. That function
-        is just like this one, except that a new Categorical is returned
-        by default, so make sure to pass in 'inplace=True' to get
-        inplace sorting.
+        .. deprecated:: 0.18.1
+           Use :meth:`Categorical.sort_values`. That function
+           is just like this one, except that a new Categorical is returned
+           by default, so make sure to pass in 'inplace=True' to get
+           inplace sorting.
 
         See Also
         --------

pandas/core/common.py

@@ -548,7 +548,8 @@ def in_qtconsole():
     """
     check if we're inside an IPython qtconsole
 
-    DEPRECATED: This is no longer needed, or working, in IPython 3 and above.
+    .. deprecated:: 0.14.1
+       This is no longer needed, or working, in IPython 3 and above.
     """
     try:
         ip = get_ipython()  # noqa
@@ -566,8 +567,8 @@ def in_ipnb():
     """
     check if we're inside an IPython Notebook
 
-    DEPRECATED: This is no longer used in pandas, and won't work in IPython 3
-    and above.
+    .. deprecated:: 0.14.1
+       This is no longer used in pandas, and won't work in IPython 3 and above.
     """
     try:
         ip = get_ipython()  # noqa

pandas/core/frame.py

@@ -3477,7 +3477,8 @@ def sort_index(self, axis=0, level=None, ascending=True, inplace=False,
     def sortlevel(self, level=0, axis=0, ascending=True, inplace=False,
                   sort_remaining=True):
         """
-        DEPRECATED: use :meth:`DataFrame.sort_index`
+        .. deprecated:: 0.20.0
+           Use :meth:`DataFrame.sort_index`
 
         Sort multilevel index by chosen axis and primary level. Data will be
         lexicographically sorted by the chosen level followed by the other

pandas/core/generic.py

@@ -1322,9 +1322,10 @@ def to_sql(self, name, con, flavor=None, schema=None, if_exists='fail',
             Using SQLAlchemy makes it possible to use any DB supported by that
             library. If a DBAPI2 object, only sqlite3 is supported.
         flavor : 'sqlite', default None
-            DEPRECATED: this parameter will be removed in a future version,
-            as 'sqlite' is the only supported option if SQLAlchemy is not
-            installed.
+            .. deprecated:: 0.19.0
+               This parameter will be removed in a future version,
+               as 'sqlite' is the only supported option if SQLAlchemy is not
+               installed.
         schema : string, default None
             Specify the schema (if database flavor supports this). If None, use
             default schema.
@@ -3162,7 +3163,8 @@ def _consolidate(self, inplace=False):
 
     def consolidate(self, inplace=False):
         """
-        DEPRECATED: consolidate will be an internal implementation only.
+        .. deprecated:: 0.20.0
+           Consolidate will be an internal implementation only.
         """
         # 15483
         warnings.warn("consolidate is deprecated and will be removed in a "
@@ -3373,7 +3375,9 @@ def astype(self, dtype, copy=True, errors='raise', **kwargs):
 
             .. versionadded:: 0.20.0
 
-        raise_on_error : DEPRECATED use ``errors`` instead
+        raise_on_error : raise on invalid input
+            .. deprecated:: 0.20.0
+               Use ``errors`` instead
         kwargs : keyword arguments to pass on to the constructor
 
         Returns
@@ -3476,7 +3480,7 @@ def _convert(self, datetime=False, numeric=False, timedelta=False,
     def convert_objects(self, convert_dates=True, convert_numeric=False,
                         convert_timedeltas=True, copy=True):
         """
-        Deprecated.
+        .. deprecated:: 0.18.0
 
         Attempt to infer better dtype for object columns
 
@@ -5684,8 +5688,9 @@ def tz_localize(self, tz, axis=0, level=None, copy=True,
             - 'NaT' will return NaT where there are ambiguous times
             - 'raise' will raise an AmbiguousTimeError if there are ambiguous
               times
-        infer_dst : boolean, default False (DEPRECATED)
-            Attempt to infer fall dst-transition hours based on order
+        infer_dst : boolean, default False
+            .. deprecated:: 0.15.0
+               Attempt to infer fall dst-transition hours based on order
 
         Returns
         -------

pandas/core/indexes/base.py

@@ -1008,7 +1008,8 @@ def _to_safe_for_reshape(self):
 
     def to_datetime(self, dayfirst=False):
         """
-        DEPRECATED: use :meth:`pandas.to_datetime` instead.
+        .. deprecated:: 0.19.0
+           Use :meth:`pandas.to_datetime` instead.
 
         For an Index containing strings or datetime.datetime objects, attempt
         conversion to DatetimeIndex

pandas/core/indexes/datetimes.py

@@ -197,8 +197,9 @@ class DatetimeIndex(DatelikeOps, TimelikeOps, DatetimeIndexOpsMixin,
           times)
         - 'NaT' will return NaT where there are ambiguous times
         - 'raise' will raise an AmbiguousTimeError if there are ambiguous times
-    infer_dst : boolean, default False (DEPRECATED)
-        Attempt to infer fall dst-transition hours based on order
+    infer_dst : boolean, default False
+        .. deprecated:: 0.15.0
+           Attempt to infer fall dst-transition hours based on order
     name : object
         Name to be stored in the index
 
@@ -1818,8 +1819,9 @@ def tz_localize(self, tz, ambiguous='raise', errors='raise'):
 
             .. versionadded:: 0.19.0
 
-        infer_dst : boolean, default False (DEPRECATED)
-            Attempt to infer fall dst-transition hours based on order
+        infer_dst : boolean, default False
+            .. deprecated:: 0.15.0
+               Attempt to infer fall dst-transition hours based on order
 
         Returns
         -------

pandas/core/indexes/period.py

@@ -566,7 +566,8 @@ def asfreq(self, freq=None, how='E'):
 
     def to_datetime(self, dayfirst=False):
         """
-        DEPRECATED: use :meth:`to_timestamp` instead.
+        .. deprecated:: 0.19.0
+           Use :meth:`to_timestamp` instead.
 
         Cast to DatetimeIndex.
         """

pandas/core/panel4d.py

@@ -19,10 +19,11 @@
     having 4 named dimensions. It is intended as a test bed for more
     N-Dimensional named containers.
 
-    DEPRECATED. Panel4D is deprecated and will be removed in a future version.
-    The recommended way to represent these types of n-dimensional data are with
-    the `xarray package <http://xarray.pydata.org/en/stable/>`__.
-    Pandas provides a `.to_xarray()` method to automate this conversion.
+    .. deprecated:: 0.19.0
+       Panel4D is deprecated and will be removed in a future version.
+       The recommended way to represent these types of n-dimensional data
+       are with the `xarray package <http://xarray.pydata.org/en/stable/>`__.
+       Pandas provides a `.to_xarray()` method to automate this conversion.
 
     Parameters
     ----------

pandas/core/panelnd.py

@@ -9,10 +9,11 @@ def create_nd_panel_factory(klass_name, orders, slices, slicer, aliases=None,
                             stat_axis=2, info_axis=0, ns=None):
     """ manufacture a n-d class:
 
-    DEPRECATED. Panelnd is deprecated and will be removed in a future version.
-    The recommended way to represent these types of n-dimensional data are with
-    the `xarray package <http://xarray.pydata.org/en/stable/>`__.
-    Pandas provides a `.to_xarray()` method to automate this conversion.
+    .. deprecated:: 0.19.0
+       Panelnd is deprecated and will be removed in a future version.
+       The recommended way to represent these types of n-dimensional data
+       are with the `xarray package <http://xarray.pydata.org/en/stable/>`__.
+       Pandas provides a `.to_xarray()` method to automate this conversion.
 
     Parameters
     ----------

pandas/core/series.py

@@ -850,8 +850,9 @@ def repeat(self, repeats, *args, **kwargs):
 
     def reshape(self, *args, **kwargs):
         """
-        DEPRECATED: calling this method will raise an error in a
-        future release. Please call ``.values.reshape(...)`` instead.
+        .. deprecated:: 0.19.0
+           Calling this method will raise an error in a future release.
+           Please call ``.values.reshape(...)`` instead.
 
         return an ndarray with the values shape
         if the specified shape matches exactly the current shape, then
@@ -1940,7 +1941,8 @@ def nsmallest(self, n=5, keep='first'):
 
     def sortlevel(self, level=0, ascending=True, sort_remaining=True):
         """
-        DEPRECATED: use :meth:`Series.sort_index`
+        .. deprecated:: 0.20.0
+           Use :meth:`Series.sort_index`
 
         Sort Series with MultiIndex by chosen level. Data will be
         lexicographically sorted by the chosen level followed by the other

pandas/core/sparse/array.py

@@ -391,8 +391,9 @@ def to_dense(self, fill=None):
         Parameters
         ----------
         fill: float, default None
-            DEPRECATED: this argument will be removed in a future version
-            because it is not respected by this function.
+            .. deprecated:: 0.20.0
+               This argument will be removed in a future version
+               because it is not respected by this function.
 
         Returns
         -------

pandas/core/strings.py

@@ -478,7 +478,10 @@ def str_match(arr, pat, case=True, flags=0, na=np.nan, as_indexer=None):
     flags : int, default 0 (no flags)
         re module flags, e.g. re.IGNORECASE
     na : default NaN, fill value for missing values.
-    as_indexer : DEPRECATED
+    as_indexer : False, by default, gives deprecated behavior better
+        achieved using str_extract. True return boolean indexer.
+        .. deprecated:: 0.20.0
+           Keyword is ignored
 
     Returns
     -------