DOC: update the pandas.Series.str.split docstring

[mananpal1997]

Following up from discussion on #20282

• PR title is "DOC: update the pandas.Series.str.split docstring"
• The validation script passes: scripts/validate_docstrings.py pandas.Series.str.split docstring
• The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
• The html version looks good: python doc/make.py --single pandas.Series.str.split docstring

################################################################################
##################### Docstring (pandas.Series.str.split)  #####################
################################################################################

Split strings around given separator/delimiter.

Split each string in the caller's values by given
pattern, propagating NaN values. Equivalent to :meth:`str.split`.

Parameters
----------
pat : str, optional
    String or regular expression to split on.
    If not specified, split on whitespace.
n : int, default -1 (all)
    Limit number of splits in output.
    ``None``, 0 and -1 will be interpreted as return all splits.
expand : bool, default False
    Expand the splitted strings into separate columns.

    * If ``True``, return DataFrame/MultiIndex expanding dimensionality.
    * If ``False``, return Series/Index, containing lists of strings.

Returns
-------
split : Series/Index or DataFrame/MultiIndex of objects
    Type matches caller unless ``expand=True`` (return type is DataFrame or
MultiIndex)

Notes
-----
The handling of the `n` keyword depends on the number of found splits:

- If found splits > `n`,  make first `n` splits only
- If found splits <= `n`, make all splits
- If for a certain row the number of found splits < `n`,
  append `None` for padding up to `n` if ``expand=True``

Examples
--------
>>> s = pd.Series(["this is good text", "but this is even better"])

By default, split will return an object of the same size
having lists containing the split elements

>>> s.str.split()
0           [this, is, good, text]
1    [but, this, is, even, better]
dtype: object
>>> s.str.split("random")
0          [this is good text]
1    [but this is even better]
dtype: object

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
0  this    is  good  text    None
1   but  this    is  even  better
>>> s.str.split(" is ", expand=True)
          0            1
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)
0          [th,  is good text]
1    [but th,  is even better]
dtype: object
>>> s.str.split("is", n=1, expand=True)
        0                1
0      th     is good text
1  but th   is even better

If NaN is present, it is propagated throughout the columns
during the split.

>>> s = pd.Series(["this is good text", "but this is even better", np.nan])
>>> s.str.split(n=3, expand=True)
      0     1     2            3
0  this    is  good         text
1   but  this    is  even better
2   NaN   NaN   NaN          NaN

################################################################################
################################## Validation ##################################
################################################################################

Errors found:
	See Also section not found

@jorisvandenbossche @WillAyd

[jorisvandenbossche]

@mananpal1997 Thanks!

Additional comment: on line 1121, the indentation should be the same as the line above, can you fix that as well? (cannot comment on that line :-))

@WillAyd did you have a proposal to write the Returns section more clear?

[WillAyd]

Nice job @mananpal1997. I suggest the Return type line just say Series, DataFrame, Index or MultiIndex and the description for the return should say Type matches caller unless ``expand=True`` (see Notes). Then in the notes say something like if using ``expand=True``, Series and Index callers will return DataFrame and MultiIndex objects, respectively.

[WillAyd]

Since you are only returning one item you don't need to list the variable name, so get rid of "split : ". Also chop " of objects" off the end

[mananpal1997]

done 👍

[mananpal1997]

@WillAyd I was trying to resolve for coverage and I think I messed up with PR. Does everything look good to you? 😅

[codecov]

Codecov Report

Merging #20307 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #20307   +/-   ##
=======================================
  Coverage    91.7%    91.7%           
=======================================
  Files         150      150           
  Lines       49165    49165           
=======================================
  Hits        45087    45087           
  Misses       4078     4078

Flag	Coverage Δ
#multiple	90.09% <ø> (ø)	⬆️
#single	41.86% <ø> (ø)	⬆️

Impacted Files	Coverage Δ
pandas/core/strings.py	98.32% <ø> (ø)	⬆️
pandas/core/series.py	93.84% <0%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7169830...27548e8. Read the comment docs.

[TomAugspurger]

Added a see also. Thanks @mananpal1997.