Skip to content

DOC: Deleted 'replaced' from Returns docstring #22563

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

Merged
merged 2 commits into from
Sep 2, 2018
Merged

DOC: Deleted 'replaced' from Returns docstring #22563

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0000c8d
Deleted 'replaced' from Returns docstring
Sep 1, 2018
0c1193a
Added Returns description
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
2 changes: 1 addition & 1 deletion pandas/core/strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -558,7 +558,7 @@ def str_replace(arr, pat, repl, n=-1, case=None, flags=0, regex=True):

Returns
-------
replaced : Series/Index of objects
Series/Index of objects
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 we usually document this as Series or Index of object (note I also change objects to object).

Also, If you can add a description in the next line, indented with four spaces, explaining what this method returns, that would be great.


Raises
------
Expand Down