Skip to content

Adding doc string to say deprecated params #3

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
Apr 13, 2015
Merged
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
5 changes: 3 additions & 2 deletions pandas/core/strings.py
Original file line number Diff line number Diff line change
Expand Up @@ -624,6 +624,7 @@ def str_pad(arr, width, side='left', fillchar=' '):

def str_split(arr, pat=None, n=None, return_type='series'):
"""
Deprecated: return_types 'series', 'index', 'frame' are now deprecated
Split each string (a la re.split) in array by given pattern, propagating NA
values

Expand All @@ -632,8 +633,8 @@ def str_split(arr, pat=None, n=None, return_type='series'):
pat : string, default None
String or regular expression to split on. If None, splits on whitespace
n : int, default None (all)
return_type : {'series', 'index', 'frame', 'same', 'expand'}, default 'series'
If frame or expand, returns a DataFrame (elements are strings)
return_type : {'same', 'expand'}, default 'series'
If expand, returns a DataFrame (elements are strings)
If series, index or same, returns the same type as the original object
(elements are lists of strings).

Expand Down