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

This commit is contained in:
Raymond Hettinger 2019-08-08 01:23:05 -07:00 • committed by GitHub
parent 7d44e7a456
commit e43e7ed364
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

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: