Skip to content

Commit

Permalink
DOC: cleanup str changes in whatsnew
Browse files Browse the repository at this point in the history
  • Loading branch information
jreback committed Feb 9, 2016
1 parent 67730dd commit 47f0222
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions doc/source/whatsnew/v0.18.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -145,15 +145,15 @@ Changes to str.extract
The :ref:`.str.extract <text.extract>` method takes a regular
expression with capture groups, finds the first match in each subject
string, and returns the contents of the capture groups
(:issue:`11386`). In v0.18.0, the ``expand`` argument was added to
``extract``. When ``expand=False`` it returns a ``Series``, ``Index``,
or ``DataFrame``, depending on the subject and regular expression
pattern (same behavior as pre-0.18.0). When ``expand=True`` it always
returns a ``DataFrame``, which is more consistent and less confusing
from the perspective of a user. Currently the default is
``expand=None`` which gives a ``FutureWarning`` and uses
``expand=False``. To avoid this warning, please explicitly specify
``expand``.
(:issue:`11386`).

In v0.18.0, the ``expand`` argument was added to
``extract``.

- ``expand=False``: it returns a ``Series``, ``Index``, or ``DataFrame``, depending on the subject and regular expression pattern (same behavior as pre-0.18.0).
- ``expand=True``: it always returns a ``DataFrame``, which is more consistent and less confusing from the perspective of a user.

Currently the default is ``expand=None`` which gives a ``FutureWarning`` and uses ``expand=False``. To avoid this warning, please explicitly specify ``expand``.

.. ipython:: python

Expand Down Expand Up @@ -205,6 +205,9 @@ In summary, ``extract(expand=True)`` always returns a ``DataFrame``
with a row for every subject string, and a column for every capture
group.

Addition of str.extractall
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. _whatsnew_0180.enhancements.extractall:

The :ref:`.str.extractall <text.extractall>` method was added
Expand Down

0 comments on commit 47f0222

Please sign in to comment.