classification
Title: statistics: incorrect documentation
Type: Stage: resolved
Components: Documentation Versions: Python 3.9, Python 3.8, Python 3.7, Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: rhettinger Nosy List: docs@python, lebigot, rhettinger, steven.daprano
Priority: low Keywords: patch

Created on 2019-10-06 19:10 by lebigot, last changed 2019-11-12 08:04 by rhettinger. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 17111 merged rhettinger, 2019-11-12 05:36
PR 17113 merged miss-islington, 2019-11-12 07:35
Messages (4)
msg354043 - (view) Author: Eric O. LEBIGOT (lebigot) Date: 2019-10-06 19:10
The documentation for the statistics package indicates that many of its functions (like median()) accept iterators. They seem to actually accept something more convenient, namely iterables.

Thus, iterator could probably be  usefully replaced by iterable on many of the functions (when applicable, which I would expect is everywhere).
msg354044 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2019-10-06 19:20
This is a reasonable suggestion (all iterators are iterable, but not all iterables are iterators).  I'll work on it shortly (in conjunction with some other minor doc fixups).
msg356421 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2019-11-12 07:35
New changeset 733b9a308e3c49855888e2e12397ae56d831e780 by Raymond Hettinger in branch 'master':
bpo-38385: Fix iterator/iterable terminology in statistics docs (GH-17111)
https://github.com/python/cpython/commit/733b9a308e3c49855888e2e12397ae56d831e780
msg356425 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2019-11-12 08:04
New changeset 3562439eb293c5fe90b1f1fe507d57d2f4fcd044 by Raymond Hettinger (Miss Islington (bot)) in branch '3.8':
bpo-38385: Fix iterator/iterable terminology in statistics docs (GH-17111) (GH-17113)
https://github.com/python/cpython/commit/3562439eb293c5fe90b1f1fe507d57d2f4fcd044
History
Date User Action Args
2019-11-12 08:04:20rhettingersetmessages: + msg356425
2019-11-12 07:36:28rhettingersetpriority: normal -> low
status: open -> closed
resolution: fixed
stage: patch review -> resolved
2019-11-12 07:35:20miss-islingtonsetpull_requests: + pull_request16620
2019-11-12 07:35:09rhettingersetmessages: + msg356421
2019-11-12 05:36:29rhettingersetkeywords: + patch
stage: patch review
pull_requests: + pull_request16618
2019-10-06 19:20:19rhettingersetassignee: docs@python -> rhettinger

messages: + msg354044
nosy: + steven.daprano, rhettinger
2019-10-06 19:10:16lebigotcreate