From 3f92a6941919ad33f618dfab81dd2183edbc00e0 Mon Sep 17 00:00:00 2001 From: Luca Donini Date: Sat, 1 Sep 2018 14:05:27 +0200 Subject: [PATCH 1/3] Corrected the formatting in the return value and added a period at the end of the parameter descriptions. Can also clarify descriptions if useful. --- pandas/core/strings.py | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/pandas/core/strings.py b/pandas/core/strings.py index e455c751057d1..b8021932cdaa1 100644 --- a/pandas/core/strings.py +++ b/pandas/core/strings.py @@ -942,19 +942,20 @@ 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 + re module flags, e.g. re.IGNORECASE. 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 regular + expression pat will be used for column names; otherwise capture + group numbers will be used. See Also -------- From ba1995ee5d2c77f84a8cba53cda0df5813a31ef1 Mon Sep 17 00:00:00 2001 From: Luca Donini Date: Sat, 1 Sep 2018 16:11:27 +0200 Subject: [PATCH 2/3] Improved description of "flags" argument and general formatting. --- pandas/core/strings.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/pandas/core/strings.py b/pandas/core/strings.py index b8021932cdaa1..00b0f932466b8 100644 --- a/pandas/core/strings.py +++ b/pandas/core/strings.py @@ -945,15 +945,18 @@ def str_extractall(arr, pat, flags=0): 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 ------- 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 regular + 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 regular expression pat will be used for column names; otherwise capture group numbers will be used. @@ -1001,7 +1004,6 @@ def str_extractall(arr, pat, flags=0): 1 a 2 B 0 b 1 C 0 NaN 1 - """ regex = re.compile(pat, flags=flags) From c96440708fc3ef176cc014f1a16a0d4c7e2e31b2 Mon Sep 17 00:00:00 2001 From: Luca Donini Date: Sat, 1 Sep 2018 16:15:38 +0200 Subject: [PATCH 3/3] pep8 --- pandas/core/strings.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/strings.py b/pandas/core/strings.py index 00b0f932466b8..75d3349f93540 100644 --- a/pandas/core/strings.py +++ b/pandas/core/strings.py @@ -946,8 +946,8 @@ def str_extractall(arr, pat, flags=0): Regular expression pattern with capturing groups. flags : int, default 0 (no flags) 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, + 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 @@ -956,8 +956,8 @@ def str_extractall(arr, pat, flags=0): 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 regular - expression pat will be used for column names; otherwise capture + matches in each item of the ``Series``. Any capture group names in + regular expression pat will be used for column names; otherwise capture group numbers will be used. See Also