docstring update: added more examples for pandas.Series.str.split() method

Author: mananpal1997

pandas/core/strings.py

@@ -1118,7 +1118,7 @@ def str_split(arr, pat=None, n=None):
     -------
     split : Series/Index or DataFrame/MultiIndex of objects
         Type matches caller unless ``expand=True`` (return type is DataFrame or
-    MultiIndex)
+        MultiIndex)
 
     Notes
     -----
@@ -1145,8 +1145,10 @@ def str_split(arr, pat=None, n=None):
     1    [but this is even better]
     dtype: object
 
-    When using ``expand=True``, the split elements will
-    expand out into separate columns.
+    When using ``expand=True``, the split elements will expand out into
+    separate columns.
+
+    For Series object, output return type is DataFrame.
 
     >>> s.str.split(expand=True)
           0     1     2     3       4
@@ -1157,6 +1159,13 @@ def str_split(arr, pat=None, n=None):
     0      this    good text
     1  but this  even better
 
+    For Index object, output return type is MultiIndex.
+
+    >>> i = pd.Index(["ba 100 001", "ba 101 002", "ba 102 003"])
+    >>> i.str.split(expand=True)
+    MultiIndex(levels=[['ba'], ['100', '101', '102'], ['001', '002', '003']],
+           labels=[[0, 0, 0], [0, 1, 2], [0, 1, 2]])
+
     Parameter `n` can be used to limit the number of splits in the output.
 
     >>> s.str.split("is", n=1)