DOC: Reset index examples

closes pandas-dev#16416 Author: aernlund <awe220@nyumc.org> Closes pandas-dev#16967 from aernlund/reset_index_docs and squashes the following commits: 3c6a4b6 [aernlund] DOC: added examples to reset_index 4838155 [aernlund] DOC: added examples to reset_index 2a51e2b [aernlund] DOC: added examples to reset_index
3553x · Jul 16, 2017 · 6600235 · 6600235
1 parent d38b1b0
commit 6600235
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 0 deletions.
diff --git a/pandas/core/frame.py b/pandas/core/frame.py
@@ -3020,6 +3020,38 @@ def reset_index(self, level=None, drop=False, inplace=False, col_level=0,
         Returns
         -------
         resetted : DataFrame
+
+        Examples
+        --------
+        >>> df = pd.DataFrame({'a': [1, 2, 3, 4], 'b': [5, 6, 7, 8]},
+        ...                   index=pd.Index(['a', 'b', 'c', 'd'],
+        ...                                  name='idx'))
+        >>> df.reset_index()
+          idx  a  b
+        0   a  1  5
+        1   b  2  6
+        2   c  3  7
+        3   d  4  8
+
+        >>> arrays = [np.array(['bar', 'bar', 'baz', 'baz', 'foo',
+        ...                     'foo', 'qux', 'qux']),
+        ...           np.array(['one', 'two', 'one', 'two', 'one', 'two',
+        ...                     'one', 'two'])]
+        >>> df2 = pd.DataFrame(
+        ...     np.random.randn(8, 4),
+        ...     index=pd.MultiIndex.from_arrays(arrays,
+        ...                                     names=['a', 'b']))
+        >>> df2.reset_index(level='a')
+               a         0         1         2         3
+        b
+        one  bar -1.099413  0.291838  0.598198  0.162181
+        two  bar -0.312184 -0.119904  0.250360  0.364378
+        one  baz  0.713596 -0.490636  0.074967 -0.297857
+        two  baz  0.998397  0.524499 -2.228976  0.901155
+        one  foo  0.923204  0.920695  1.264488  1.476921
+        two  foo -1.566922  0.783278 -0.073656  0.266027
+        one  qux -0.230470  0.109800 -1.383409  0.048421
+        two  qux -0.865993 -0.865984  0.705367 -0.170446
         """
         inplace = validate_bool_kwarg(inplace, 'inplace')
         if inplace:

diff --git a/pandas/core/series.py b/pandas/core/series.py
@@ -948,6 +948,37 @@ def reset_index(self, level=None, drop=False, name=None, inplace=False):
         Returns
         ----------
         resetted : DataFrame, or Series if drop == True
+
+        Examples
+        --------
+        >>> s = pd.Series([1, 2, 3, 4], index=pd.Index(['a', 'b', 'c', 'd'],
+        ...                                            name = 'idx'))
+        >>> s.reset_index()
+           index  0
+        0      0  1
+        1      1  2
+        2      2  3
+        3      3  4
+
+        >>> arrays = [np.array(['bar', 'bar', 'baz', 'baz', 'foo',
+        ...                     'foo', 'qux', 'qux']),
+        ...           np.array(['one', 'two', 'one', 'two', 'one', 'two',
+        ...                     'one', 'two'])]
+        >>> s2 = pd.Series(
+        ...     np.random.randn(8),
+        ...     index=pd.MultiIndex.from_arrays(arrays,
+        ...                                     names=['a', 'b']))
+        >>> s2.reset_index(level='a')
+               a         0
+        b
+        one  bar -0.286320
+        two  bar -0.587934
+        one  baz  0.710491
+        two  baz -1.429006
+        one  foo  0.790700
+        two  foo  0.824863
+        one  qux -0.718963
+        two  qux -0.055028
         """
         inplace = validate_bool_kwarg(inplace, 'inplace')
         if drop: