DOC: Update Series.mode docstring

[scajanus]

• closes #xxxx
• tests added / passed
• passes git diff upstream/master | flake8 --diff
• whatsnew entry

Series mode method does not support sort parameter, even though the documentation says so. Neither does the underlying function from pandas.core.algorithms.

[codecov-io]

Current coverage is 85.28% (diff: 100%)

Merging #14653 into master will not change coverage

@@             master     #14653   diff @@
==========================================
  Files           140        140          
  Lines         50693      50693          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits          43234      43234          
  Misses         7459       7459          
  Partials          0          0          

Powered by Codecov. Last update 1d6dbb4...0d250c2

[jorisvandenbossche]

@sakkemo Thanks for the PR!

This was added in the original PR that added the mode method, but this indeed does not really seem to be correct (#5380). Possibly the return values will be sorted if there are multiple return values?

[scajanus]

Yes, the return values are sorted! It says so in the return value part of the docstring (hidden by the fold in github by default), but perhaps it could be added in the description as well.

     Returns
     -------
     modes : Series (sorted)

Regarding the list at the top, do I need to add an issue? Also I didn't know to which whatsnew file add the changes, 0.19.2 or 0.20.0. It depends on when this is merged, of course.

[jorisvandenbossche]

@sakkemo Thanks!