Skip to content

DOC: Removed references to v0.17 in docs and doc strings #17923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 30, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions doc/source/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1738,11 +1738,6 @@ description.
Sorting
-------

.. warning::

The sorting API is substantially changed in 0.17.0, see :ref:`here <whatsnew_0170.api_breaking.sorting>` for these changes.
In particular, all sorting methods now return a new object by default, and **DO NOT** operate in-place (except by passing ``inplace=True``).

There are two obvious kinds of sorting that you may be interested in: sorting
by label and sorting by actual values.

Expand Down Expand Up @@ -1829,8 +1824,6 @@ faster than sorting the entire Series and calling ``head(n)`` on the result.
s.nsmallest(3)
s.nlargest(3)

.. versionadded:: 0.17.0

``DataFrame`` also has the ``nlargest`` and ``nsmallest`` methods.

.. ipython:: python
Expand Down Expand Up @@ -1881,7 +1874,7 @@ dtypes
------

The main types stored in pandas objects are ``float``, ``int``, ``bool``,
``datetime64[ns]`` and ``datetime64[ns, tz]`` (in >= 0.17.0), ``timedelta[ns]``,
``datetime64[ns]`` and ``datetime64[ns, tz]``, ``timedelta[ns]``,
``category`` and ``object``. In addition these dtypes have item sizes, e.g.
``int64`` and ``int32``. See :ref:`Series with TZ <timeseries.timezone_series>`
for more detail on ``datetime64[ns, tz]`` dtypes.
Expand Down
2 changes: 0 additions & 2 deletions doc/source/categorical.rst
Original file line number Diff line number Diff line change
Expand Up @@ -632,8 +632,6 @@ To get a single value `Series` of type ``category`` pass in a list with a single
String and datetime accessors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 0.17.1

The accessors ``.dt`` and ``.str`` will work if the ``s.cat.categories`` are of an appropriate
type:

Expand Down
2 changes: 0 additions & 2 deletions doc/source/computation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,6 @@ Window Functions
functions and are now deprecated. These are replaced by using the :class:`~pandas.core.window.Rolling`, :class:`~pandas.core.window.Expanding` and :class:`~pandas.core.window.EWM`. objects and a corresponding method call.

The deprecation warning will show the new syntax, see an example :ref:`here <whatsnew_0180.window_deprecations>`
You can view the previous documentation
`here <http://pandas.pydata.org/pandas-docs/version/0.17.1/computation.html#moving-rolling-statistics-moments>`__

For working with data, a number of windows functions are provided for
computing common *window* or *rolling* statistics. Among these are count, sum,
Expand Down
8 changes: 4 additions & 4 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -877,12 +877,12 @@ directive is used. The sphinx syntax for that is:

.. code-block:: rst

.. versionadded:: 0.17.0
.. versionadded:: 0.21.0

This will put the text *New in version 0.17.0* wherever you put the sphinx
This will put the text *New in version 0.21.0* wherever you put the sphinx
directive. This should also be put in the docstring when adding a new function
or method (`example <https://github.com/pandas-dev/pandas/blob/v0.16.2/pandas/core/generic.py#L1959>`__)
or a new keyword argument (`example <https://github.com/pandas-dev/pandas/blob/v0.16.2/pandas/core/frame.py#L1171>`__).
or method (`example <https://github.com/pandas-dev/pandas/blob/v0.20.2/pandas/core/frame.py#L1495>`__)
or a new keyword argument (`example <https://github.com/pandas-dev/pandas/blob/v0.20.2/pandas/core/generic.py#L568>`__).

Contributing your changes to *pandas*
=====================================
Expand Down
5 changes: 4 additions & 1 deletion doc/source/ecosystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,10 @@ API

`pandas-datareader <https://github.com/pydata/pandas-datareader>`__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``pandas-datareader`` is a remote data access library for pandas. ``pandas.io`` from pandas < 0.17.0 is now refactored/split-off to and importable from ``pandas_datareader`` (PyPI:``pandas-datareader``). Many/most of the supported APIs have at least a documentation paragraph in the `pandas-datareader docs <https://pandas-datareader.readthedocs.io/en/latest/>`_:
``pandas-datareader`` is a remote data access library for pandas (PyPI:``pandas-datareader``).
It is based on functionality that was located in ``pandas.io.data`` and ``pandas.io.wb`` but was
split off in v0.19.
See more in the `pandas-datareader docs <https://pandas-datareader.readthedocs.io/en/latest/>`_:

The following data feeds are available:

Expand Down
2 changes: 0 additions & 2 deletions doc/source/gotchas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ The ``+`` symbol indicates that the true memory usage could be higher, because
pandas does not count the memory used by values in columns with
``dtype=object``.

.. versionadded:: 0.17.1

Passing ``memory_usage='deep'`` will enable a more accurate memory usage report,
that accounts for the full usage of the contained objects. This is optional
as it can be expensive to do this deeper introspection.
Expand Down
2 changes: 0 additions & 2 deletions doc/source/indexing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1632,8 +1632,6 @@ Missing values

.. _indexing.missing:

.. versionadded:: 0.17.1

.. important::

Even though ``Index`` can hold missing values (``NaN``), it should be avoided
Expand Down
50 changes: 3 additions & 47 deletions doc/source/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2689,11 +2689,6 @@ of sheet names can simply be passed to ``read_excel`` with no loss in performanc
# equivalent using the read_excel function
data = read_excel('path_to_file.xls', ['Sheet1', 'Sheet2'], index_col=None, na_values=['NA'])

.. versionadded:: 0.17

``read_excel`` can take an ``ExcelFile`` object as input


.. _io.excel.specifying_sheets:

Specifying Sheets
Expand Down Expand Up @@ -2754,8 +2749,6 @@ respectively.
Reading a ``MultiIndex``
++++++++++++++++++++++++

.. versionadded:: 0.17

``read_excel`` can read a ``MultiIndex`` index, by passing a list of columns to ``index_col``
and a ``MultiIndex`` column by passing a list of rows to ``header``. If either the ``index``
or ``columns`` have serialized level names those will be read in as well by specifying
Expand Down Expand Up @@ -2928,14 +2921,8 @@ one can pass an :class:`~pandas.io.excel.ExcelWriter`.
Writing Excel Files to Memory
+++++++++++++++++++++++++++++

.. versionadded:: 0.17

Pandas supports writing Excel files to buffer-like objects such as ``StringIO`` or
``BytesIO`` using :class:`~pandas.io.excel.ExcelWriter`.

.. versionadded:: 0.17

Added support for Openpyxl >= 2.2
``BytesIO`` using :class:`~pandas.io.excel.ExcelWriter`. Pandas also supports Openpyxl >= 2.2.

.. code-block:: python

Expand Down Expand Up @@ -3191,25 +3178,6 @@ both on the writing (serialization), and reading (deserialization).
optimizations in the io of the ``msgpack`` data. Since this is marked
as an EXPERIMENTAL LIBRARY, the storage format may not be stable until a future release.

As a result of writing format changes and other issues:

+----------------------+------------------------+
| Packed with | Can be unpacked with |
+======================+========================+
| pre-0.17 / Python 2 | any |
+----------------------+------------------------+
| pre-0.17 / Python 3 | any |
+----------------------+------------------------+
| 0.17 / Python 2 | - 0.17 / Python 2 |
| | - >=0.18 / any Python |
+----------------------+------------------------+
| 0.17 / Python 3 | >=0.18 / any Python |
+----------------------+------------------------+
| 0.18 | >= 0.18 |
+----------------------+------------------------+

Reading (files packed by older versions) is backward-compatibile, except for files packed with 0.17 in Python 2, in which case only they can only be unpacked in Python 2.

.. ipython:: python

df = pd.DataFrame(np.random.rand(5,2),columns=list('AB'))
Expand Down Expand Up @@ -3287,10 +3255,6 @@ for some advanced strategies
If you see a subset of results being returned, upgrade to ``PyTables`` >= 3.2.
Stores created previously will need to be rewritten using the updated version.

.. warning::

As of version 0.17.0, ``HDFStore`` will not drop rows that have all missing values by default. Previously, if all values (except the index) were missing, ``HDFStore`` would not write those rows to disk.

.. ipython:: python
:suppress:
:okexcept:
Expand Down Expand Up @@ -3388,7 +3352,7 @@ similar to how ``read_csv`` and ``to_csv`` work.
os.remove('store_tl.h5')


As of version 0.17.0, HDFStore will no longer drop rows that are all missing by default. This behavior can be enabled by setting ``dropna=True``.
HDFStore will by default not drop rows that are all missing. This behavior can be changed by setting ``dropna=True``.

.. ipython:: python
:suppress:
Expand Down Expand Up @@ -3632,12 +3596,6 @@ Querying
Querying a Table
++++++++++++++++

.. warning::

This query capabilities have changed substantially starting in ``0.13.0``.
Queries from prior version are accepted (with a ``DeprecationWarning``) printed
if its not string-like.

``select`` and ``delete`` operations have an optional criterion that can
be specified to select/delete only a subset of the data. This allows one
to have a very large on-disk table and retrieve only a portion of the
Expand Down Expand Up @@ -5098,10 +5056,8 @@ whether imported ``Categorical`` variables are ordered.
SAS Formats
-----------

.. versionadded:: 0.17.0

The top-level function :func:`read_sas` can read (but not write) SAS
`xport` (.XPT) and `SAS7BDAT` (.sas7bdat) format files were added in *v0.18.0*.
`xport` (.XPT) and (since *v0.18.0*) `SAS7BDAT` (.sas7bdat) format files.

SAS files only contain two value types: ASCII text and floating point
values (usually 8 bytes but sometimes truncated). For xport files,
Expand Down
6 changes: 1 addition & 5 deletions doc/source/merging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -550,8 +550,6 @@ standard database join operations between DataFrame objects:
merge key only appears in ``'right'`` DataFrame, and ``both`` if the
observation's merge key is found in both.

.. versionadded:: 0.17.0

- ``validate`` : string, default None.
If specified, checks if merge is of specified type.

Expand Down Expand Up @@ -766,9 +764,7 @@ If the user is aware of the duplicates in the right `DataFrame` but wants to ens
The merge indicator
~~~~~~~~~~~~~~~~~~~

.. versionadded:: 0.17.0

``merge`` now accepts the argument ``indicator``. If ``True``, a Categorical-type column called ``_merge`` will be added to the output object that takes on values:
``merge`` accepts the argument ``indicator``. If ``True``, a Categorical-type column called ``_merge`` will be added to the output object that takes on values:

=================================== ================
Observation Origin ``_merge`` value
Expand Down
4 changes: 0 additions & 4 deletions doc/source/missing_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -352,10 +352,6 @@ examined :ref:`in the API <api.dataframe.missing>`.
Interpolation
~~~~~~~~~~~~~

.. versionadded:: 0.17.0

The ``limit_direction`` keyword argument was added.

Both Series and DataFrame objects have an ``interpolate`` method that, by default,
performs linear interpolation at missing datapoints.

Expand Down
2 changes: 1 addition & 1 deletion doc/source/remote_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Remote Data Access
DataReader
----------

The sub-package ``pandas.io.data`` was deprecated in v.0.17 and removed in
The sub-package ``pandas.io.data`` was removed in
`v.0.19 <http://pandas-docs.github.io/pandas-docs-travis/whatsnew.html#v0-19-0-october-2-2016>`__.
Instead there has been created a separately installable
`pandas-datareader package <https://github.com/pydata/pandas-datareader>`__.
Expand Down
9 changes: 1 addition & 8 deletions doc/source/timeseries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,12 +229,7 @@ You can pass only the columns that you need to assemble.
Invalid Data
~~~~~~~~~~~~

.. note::

In version 0.17.0, the default for ``to_datetime`` is now ``errors='raise'``, rather than ``errors='ignore'``. This means
that invalid parsing will raise rather that return the original input as in previous versions.

The default behavior, ``errors='raise'``, is to raise when unparseable:
The default behavior, ``errors='raise'``, is to raise when unparseable:

.. code-block:: ipython

Expand Down Expand Up @@ -2230,8 +2225,6 @@ constructor as well as ``tz_localize``.
TZ Aware Dtypes
~~~~~~~~~~~~~~~

.. versionadded:: 0.17.0

``Series/DatetimeIndex`` with a timezone **naive** value are represented with a dtype of ``datetime64[ns]``.

.. ipython:: python
Expand Down
2 changes: 0 additions & 2 deletions doc/source/visualization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,6 @@ For example, a bar plot can be created the following way:
@savefig bar_plot_ex.png
df.iloc[5].plot(kind='bar');

.. versionadded:: 0.17.0

You can also create these other plots using the methods ``DataFrame.plot.<kind>`` instead of providing the ``kind`` keyword argument. This makes it easier to discover plot methods and the specific arguments they use:

.. ipython::
Expand Down
10 changes: 0 additions & 10 deletions pandas/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,6 @@
"right_only" for observations whose merge key only appears in 'right'
DataFrame, and "both" if the observation's merge key is found in both.

.. versionadded:: 0.17.0

validate : string, default None
If specified, checks if merge is of specified type.

Expand Down Expand Up @@ -916,8 +914,6 @@ def to_dict(self, orient='dict', into=dict):
[{column -> value}, ... , {column -> value}]
- index : dict like {index -> {column -> value}}

.. versionadded:: 0.17.0

Abbreviations are allowed. `s` indicates `series` and `sp`
indicates `split`.

Expand Down Expand Up @@ -3743,8 +3739,6 @@ def nlargest(self, n, columns, keep='first'):
"""Get the rows of a DataFrame sorted by the `n` largest
values of `columns`.

.. versionadded:: 0.17.0

Parameters
----------
n : int
Expand Down Expand Up @@ -3780,8 +3774,6 @@ def nsmallest(self, n, columns, keep='first'):
"""Get the rows of a DataFrame sorted by the `n` smallest
values of `columns`.

.. versionadded:: 0.17.0

Parameters
----------
n : int
Expand Down Expand Up @@ -5350,8 +5342,6 @@ def round(self, decimals=0, *args, **kwargs):
"""
Round a DataFrame to a variable number of decimal places.

.. versionadded:: 0.17.0

Parameters
----------
decimals : int, dict, Series
Expand Down
10 changes: 0 additions & 10 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -2415,7 +2415,6 @@ def reindex_like(self, other, method=None, copy=True, limit=None,
Maximum distance between labels of the other object and this
object for inexact matches. Can be list-like.

.. versionadded:: 0.17.0
.. versionadded:: 0.21.0 (list-like tolerance)

Notes
Expand Down Expand Up @@ -2622,8 +2621,6 @@ def add_suffix(self, suffix):
_shared_docs['sort_values'] = """
Sort by the values along either axis

.. versionadded:: 0.17.0

Parameters
----------%(optional_by)s
axis : %(axes_single_arg)s, default 0
Expand Down Expand Up @@ -2810,7 +2807,6 @@ def sort_index(self, axis=0, level=None, ascending=True, inplace=False,
the same size as the index and its dtype must exactly match the
index's type.

.. versionadded:: 0.17.0
.. versionadded:: 0.21.0 (list-like tolerance)

Examples
Expand Down Expand Up @@ -3077,7 +3073,6 @@ def _reindex_multi(self, axes, copy, fill_value):
the same size as the index and its dtype must exactly match the
index's type.

.. versionadded:: 0.17.0
.. versionadded:: 0.21.0 (list-like tolerance)

Examples
Expand Down Expand Up @@ -4658,9 +4653,6 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None,
limit_direction : {'forward', 'backward', 'both'}, default 'forward'
If limit is specified, consecutive NaNs will be filled in this
direction.

.. versionadded:: 0.17.0

inplace : bool, default False
Update the NDFrame in place if possible.
downcast : optional, 'infer' or None, defaults to None
Expand Down Expand Up @@ -5667,8 +5659,6 @@ def ranker(data):
Broadcast values along this axis, if aligning two objects of
different dimensions

.. versionadded:: 0.17.0

Returns
-------
(left, right) : (%(klass)s, type of other)
Expand Down
2 changes: 0 additions & 2 deletions pandas/core/indexes/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -2490,7 +2490,6 @@ def _get_unique_index(self, dropna=False):
includes list, tuple, array, Series, and must be the same size as
the index and its dtype must exactly match the index's type.

.. versionadded:: 0.17.0
.. versionadded:: 0.21.0 (list-like tolerance)

Returns
Expand Down Expand Up @@ -2640,7 +2639,6 @@ def _get_level_values(self, level):
the same size as the index and its dtype must exactly match the
index's type.

.. versionadded:: 0.17.0
.. versionadded:: 0.21.0 (list-like tolerance)

Examples
Expand Down
2 changes: 0 additions & 2 deletions pandas/core/indexes/datetimelike.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ def strftime(self, date_format):
supports the same string format as the python standard library. Details
of the string format can be found in `python string format doc <{0}>`__

.. versionadded:: 0.17.0

Parameters
----------
date_format : str
Expand Down
Loading