DOC: Extend docstring pandas core index to_frame method (pandas-dev#2…

…0036)
harisbal · Mar 10, 2018 · 4131149 · 4131149
1 parent 52cffa3
commit 4131149
Showing 1 changed file with 20 additions and 1 deletion.
diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py
@@ -1148,7 +1148,26 @@ def to_frame(self, index=True):
 
         Returns
         -------
-        DataFrame : a DataFrame containing the original Index data.
+        DataFrame
+            DataFrame containing the original Index data.
+
+        Examples
+        --------
+        >>> idx = pd.Index(['Ant', 'Bear', 'Cow'], name='animal')
+        >>> idx.to_frame()
+            animal
+        animal       
+        Ant       Ant
+        Bear     Bear
+        Cow       Cow
+
+        By default, the original Index is reused. To enforce a new Index:
+
+        >>> idx.to_frame(index=False)
+            animal
+        0   Ant
+        1  Bear
+        2   Cow
         """
 
         from pandas import DataFrame