Update documentation for rename #13533
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
|
needs an update to the doc string as well |
|
Updated docstring |
Current coverage is 84.33%@@ master #13533 diff @@
==========================================
Files 138 138
Lines 51111 51111
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
Hits 43107 43107
Misses 8004 8004
Partials 0 0
|
| @@ -555,8 +555,8 @@ def swaplevel(self, i=-2, j=-1, axis=0): | |||
| _shared_docs['rename'] = """ | |||
| Alter axes input function or functions. Function / dict values must be | |||
| unique (1-to-1). Labels not contained in a dict / Series will be left | |||
| as-is. Alternatively, change ``Series.name`` with a scalar | |||
| value (Series only). | |||
| as-is. Extra labels listed don't throw an error. Alternatively, change | |||
There was a problem hiding this comment.
can you add 1 or more examples in Examples
|
|
||
| .. ipython:: python | ||
|
|
||
| df.rename(columns={'one' : 'foo', 'two' : 'bar'}, | ||
| index={'a' : 'apple', 'b' : 'banana', 'd' : 'durian'}) | ||
|
|
||
| If mapping doesn't name a column/index, it isn't renamed. Also extra names |
There was a problem hiding this comment.
"If mapping doesn't name a column/index," -> "If the mapping doesn't include a column/index label"
There was a problem hiding this comment.
thank you. corrected
|
@gliptak A small grammatical comment, otherwise looks good! |
|
Thanks! |
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.
git diff upstream/master | flake8 --diff