bpo-35892: Add usage note to mode() (GH-15122) (GH-15176)

(cherry picked from commit e43e7ed364)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2019-08-08 01:36:55 -07:00 committed by Raymond Hettinger
parent 84d31bbf1f
commit 5925b7d555
1 changed files with 3 additions and 1 deletions

View File

@ -313,7 +313,9 @@ However, for reading convenience, most of the examples show sorted sequences.
measure of central location.
If there are multiple modes, returns the first one encountered in the *data*.
If *data* is empty, :exc:`StatisticsError` is raised.
If the smallest or largest of multiple modes is desired instead, use
``min(multimode(data))`` or ``max(multimode(data))``. If the input *data* is
empty, :exc:`StatisticsError` is raised.
``mode`` assumes discrete data, and returns a single value. This is the
standard treatment of the mode as commonly taught in schools: