From 34a53d1b9bdbfdf5098704d10c566cad6612208b Mon Sep 17 00:00:00 2001
From: trevorkask <86092192+trevorkask@users.noreply.github.com>
Date: Thu, 22 Jul 2021 11:26:24 -0500
Subject: [PATCH] Update frame.py

Added an example to the reorder_levels function
---
 pandas/core/frame.py | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/pandas/core/frame.py b/pandas/core/frame.py
index 8b82021375a28..fd5ffa82a20cf 100644
--- a/pandas/core/frame.py
+++ b/pandas/core/frame.py
@@ -6788,7 +6788,37 @@ def reorder_levels(self, order: Sequence[Axis], axis: Axis = 0) -> DataFrame:
         Returns
         -------
         DataFrame
-        """
+        
+        Examples
+        --------
+        >>> data={'class':['Mammals','Mammals','Reptiles','Reptiles','Amphibians','Amphibians'],
+         'diet':['Omnivore','Carnivore','Carnivore','Herbivore','Omnivore','Herbivore'],
+         'species':['Humans','Dogs','Snakes','Iguanas','Frogs','Aquatic Salamanders']
+         }
+
+        >>> df=pd.DataFrame(data,columns=['class','diet','species'])
+
+        >>> df.set_index(['class','diet'],drop=True,inplace=True)
+
+        >>> df.reorder_levels(["diet", "class"])
+             diet	   class	  species
+            Omnivore   Mammals	    Humans
+            Carnivore  Mammals	    Dogs
+                       Reptiles	    Snakes
+            Herbivore  Reptiles	    Iguanas
+            Omnivore   Amphibians	Frogs
+            Herbivore	Amphibians	Aquatic Salamanders
+
+        >>> df.reorder_levels(["class","diet"])
+              class	    diet	    species
+            Mammals	    Omnivore	Humans
+                        Carnivore	Dogs
+            Reptiles	Carnivore	Snakes
+                        Herbivore	Iguanas
+            Amphibians	Omnivore	Frogs
+                        Herbivore	Aquatic Salamanders
+        """
+        
         axis = self._get_axis_number(axis)
         if not isinstance(self._get_axis(axis), MultiIndex):  # pragma: no cover
             raise TypeError("Can only reorder levels on a hierarchical axis.")