Skip to content

[3.8] bpo-35892: Add usage note to mode() (GH-15122) #15176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 8, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Doc/library/statistics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down