-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: update the Series.reset_index DocString #20107
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
Changes from 8 commits
0d97714
291b5c0
a45970e
4e70101
8f3ddb4
25d706a
a9a69d0
28974ac
1af336d
9a27e63
0604a3c
8b0cefd
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1002,36 +1002,86 @@ def _set_value(self, label, value, takeable=False): | |
|
||
def reset_index(self, level=None, drop=False, name=None, inplace=False): | ||
""" | ||
Analogous to the :meth:`pandas.DataFrame.reset_index` function, see | ||
docstring there. | ||
Reset the index of the Series. | ||
|
||
For an Index, the index name will be used (if set), | ||
otherwise a default index or level_0 (if index is already taken) | ||
will be used. | ||
For a MultiIndex, return a new Series with labeling | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you will get a multi-column DataFrame, with each level being turned into a column, here the levels will be named level_n if the name is None. |
||
information in the columns under the index names, defaulting to | ||
level_0, level_1, etc. if any are None. | ||
|
||
Parameters | ||
---------- | ||
level : int, str, tuple, or list, default None | ||
Only remove the given levels from the index. Removes all levels by | ||
default | ||
drop : boolean, default False | ||
Do not try to insert index into dataframe columns | ||
default. | ||
drop : bool, default False | ||
Do not try to insert index into dataframe columns. | ||
name : object, default None | ||
The name of the column corresponding to the Series values | ||
inplace : boolean, default False | ||
Modify the Series in place (do not create a new object) | ||
The name of the column corresponding to the Series values. | ||
inplace : `bool`, default False | ||
Modify the Series in place (do not create a new object). | ||
|
||
Returns | ||
---------- | ||
resetted : DataFrame, or Series if drop == True | ||
reset : DataFrame, or Series if `drop == True` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. no back ticks |
||
|
||
See Also | ||
-------- | ||
pandas.DataFrame.reset_index: Analogous function for DataFrame | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. link to pandas.Series.set_index as well There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Series does not have a method set_index(), did you mean DataFrame.set_index()? s.set_index()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/Users/ludus/develop/pandas-meetup/pandas/pandas/core/generic.py", line 4046, in __getattr__
return object.__getattribute__(self, name)
AttributeError: 'Series' object has no attribute 'set_index' |
||
|
||
Examples | ||
-------- | ||
|
||
Generate a pandas.Series with a given Index. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this comment is a bit odd here |
||
|
||
>>> s = pd.Series([1, 2, 3, 4], index=pd.Index(['a', 'b', 'c', 'd'], | ||
... name = 'idx')) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. spaces around |
||
|
||
To generate a pandas.DataFrame with resetted index, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. resetted -> default index |
||
call the reset_index() method. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you don't need to say 'call the reset_index() method' |
||
|
||
>>> s.reset_index() | ||
idx 0 | ||
0 a 1 | ||
1 b 2 | ||
2 c 3 | ||
3 d 4 | ||
|
||
To specify the name of the column corrisponding | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. corrIsponding. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sp |
||
to the Series values, use the name parameter. | ||
|
||
>>> s.reset_index(name='values') | ||
idx values | ||
0 a 1 | ||
1 b 2 | ||
2 c 3 | ||
3 d 4 | ||
|
||
To generate a new pandas.Series with the resetted | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. resetted -> default index |
||
index, set the drop parameter to True. | ||
|
||
>>> s.reset_index(drop=True) | ||
0 1 | ||
1 2 | ||
2 3 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can you add an example with name There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done, for name and for inplace |
||
3 4 | ||
dtype: int64 | ||
|
||
To update the Series in place, without generating a new one | ||
set inplace to True. Note that it also requires drop=True. | ||
|
||
>>> s.reset_index(inplace=True, drop=True) | ||
>>> s | ||
0 1 | ||
1 2 | ||
2 3 | ||
3 4 | ||
dtype: int64 | ||
|
||
Generate a MultiIndex Series. | ||
|
||
>>> arrays = [np.array(['bar', 'bar', 'baz', 'baz', 'foo', | ||
... 'foo', 'qux', 'qux']), | ||
... np.array(['one', 'two', 'one', 'two', 'one', 'two', | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If I'm not wrong, just 4 rows should be enough to illustrate the example. That would make it more compact, and easier to understand for the user. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're right, that was an existing example! |
||
|
@@ -1040,6 +1090,10 @@ def reset_index(self, level=None, drop=False, name=None, inplace=False): | |
... range(8), | ||
... index=pd.MultiIndex.from_arrays(arrays, | ||
... names=['a', 'b'])) | ||
|
||
To remove a specific level from the Index, use the | ||
level parameter. | ||
|
||
>>> s2.reset_index(level='a') | ||
a 0 | ||
b | ||
|
@@ -1051,7 +1105,23 @@ def reset_index(self, level=None, drop=False, name=None, inplace=False): | |
two foo 5 | ||
one qux 6 | ||
two qux 7 | ||
|
||
If level parameter is not set, all levels are removed | ||
from the Index. | ||
|
||
>>> s2.reset_index() | ||
a b 0 | ||
0 bar one 0 | ||
1 bar two 1 | ||
2 baz one 2 | ||
3 baz two 3 | ||
4 foo one 4 | ||
5 foo two 5 | ||
6 qux one 6 | ||
7 qux two 7 | ||
""" | ||
|
||
|
||
inplace = validate_bool_kwarg(inplace, 'inplace') | ||
if drop: | ||
new_index = com._default_index(len(self)) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so this is not correct,
.reset_index(drop=False)
(the default) on a Series will return a DataFrame. The columns will be the name of the Series and a new column of the index, with its name being the name of the column or 'index' if its not named.