DOC: Deleted 'replaced' from Returns docstring #22563
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidmvalente
changed the title
pandas/core/strings.py
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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.
Codecov Report
@@ Coverage Diff @@
## master #22563 +/- ##
=======================================
Coverage 92.04% 92.04%
=======================================
Files 169 169
Lines 50787 50787
=======================================
Hits 46745 46745
Misses 4042 4042
Continue to review full report at Codecov.
|
|
Thanks for the changes @davidmvalente |
Sup3rGeo
pushed a commit
to Sup3rGeo/pandas
that referenced
this pull request
Oct 1, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deleted the word 'replaced' from the Returns section of the docstring, since it is an unnecessary local variable name.