Skip to content

Commit a5e1084

Browse files
committed
Merge pull request #3 from sreejata/master
Adding doc string to say deprecated params
2 parents 612e0c0 + d2c57da commit a5e1084

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

pandas/core/strings.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -624,6 +624,7 @@ def str_pad(arr, width, side='left', fillchar=' '):
624624

625625
def str_split(arr, pat=None, n=None, return_type='series'):
626626
"""
627+
Deprecated: return_types 'series', 'index', 'frame' are now deprecated
627628
Split each string (a la re.split) in array by given pattern, propagating NA
628629
values
629630
@@ -632,8 +633,8 @@ def str_split(arr, pat=None, n=None, return_type='series'):
632633
pat : string, default None
633634
String or regular expression to split on. If None, splits on whitespace
634635
n : int, default None (all)
635-
return_type : {'series', 'index', 'frame', 'same', 'expand'}, default 'series'
636-
If frame or expand, returns a DataFrame (elements are strings)
636+
return_type : {'same', 'expand'}, default 'series'
637+
If expand, returns a DataFrame (elements are strings)
637638
If series, index or same, returns the same type as the original object
638639
(elements are lists of strings).
639640

0 commit comments

Comments
 (0)