Skip to content
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.

Sign up for GitHub

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

DOC: Formatting in Series.str.extractall #22565

Merged
merged 3 commits into from
Sep 18, 2018
Merged

DOC: Formatting in Series.str.extractall #22565

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f92a69
Corrected the formatting in the return value and added a period at th…
lucadonini96 Sep 1, 2018
ba1995e
Improved description of "flags" argument and general formatting.
lucadonini96 Sep 1, 2018
c964407
pep8
lucadonini96 Sep 1, 2018
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
23 changes: 13 additions & 10 deletions pandas/core/strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -942,19 +942,23 @@ def str_extractall(arr, pat, flags=0):

Parameters
----------
pat : string
Regular expression pattern with capturing groups
pat : str
Regular expression pattern with capturing groups.
flags : int, default 0 (no flags)
re module flags, e.g. re.IGNORECASE
A ``re`` module flag, for example ``re.IGNORECASE``. These allow
to modify regular expression matching for things like case, spaces,
etc. Multiple flags can be combined with the bitwise OR operator,
for example ``re.IGNORECASE | re.MULTILINE``.

Returns
-------
A DataFrame with one row for each match, and one column for each
group. Its rows have a MultiIndex with first levels that come from
the subject Series. The last level is named 'match' and indicates
the order in the subject. Any capture group names in regular
expression pat will be used for column names; otherwise capture
group numbers will be used.
DataFrame
A ``DataFrame`` with one row for each match, and one column for each
group. Its rows have a ``MultiIndex`` with first levels that come from
the subject ``Series``. The last level is named 'match' and indexes the
matches in each item of the ``Series``. Any capture group names in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in DataFrame... is better to use backticks, as they are more "links to other pages" than "code" in my opinion.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant single backticks in the previous comment, instead of double backticks.

regular expression pat will be used for column names; otherwise capture
group numbers will be used.

See Also
--------
Expand Down Expand Up @@ -1000,7 +1004,6 @@ def str_extractall(arr, pat, flags=0):
1 a 2
B 0 b 1
C 0 NaN 1

"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you remove this blank line at the end before the quotes.


regex = re.compile(pat, flags=flags)
Expand Down