diff options
| author | Raymond Hettinger <rhettinger@users.noreply.github.com> | 2019-08-08 08:23:05 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-08 08:23:05 (GMT) |
| commit | e43e7ed36480190083740fd75e2b9cdca72f1a68 (patch) | |
| tree | ac2139848f59425b633e9d1ca0f6565d305e1a57 | |
| parent | 7d44e7a4563072d0fad00427b76b94cad61c38ae (diff) | |
| download | cpython-e43e7ed36480190083740fd75e2b9cdca72f1a68.zip cpython-e43e7ed36480190083740fd75e2b9cdca72f1a68.tar.gz cpython-e43e7ed36480190083740fd75e2b9cdca72f1a68.tar.bz2 | |
bpo-35892: Add usage note to mode() (GH-15122)
| -rw-r--r-- | Doc/library/statistics.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst index 3a2a1f9..bb77228 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: |