From: Raymond Hettinger <rhettinger@users.noreply.github.com>
Date: Thu, 8 Aug 2019 08:23:05 +0000 (-0700)
Subject: bpo-35892: Add usage note to mode() (GH-15122)
X-Git-Tag: v3.9.0a1~901
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e43e7ed36480190083740fd75e2b9cdca72f1a68;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst
index 3a2a1f94db47..bb77228ceac1 100644
--- a/Doc/library/statistics.rst
+++ b/Doc/library/statistics.rst
@@ -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: