Skip to content

Commit 733b9a3

Browse files
authored
bpo-38385: Fix iterator/iterable terminology in statistics docs (GH-17111)
1 parent 051ff52 commit 733b9a3

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

Doc/library/statistics.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ However, for reading convenience, most of the examples show sorted sequences.
7777

7878
.. function:: mean(data)
7979

80-
Return the sample arithmetic mean of *data* which can be a sequence or iterator.
80+
Return the sample arithmetic mean of *data* which can be a sequence or iterable.
8181

8282
The arithmetic mean is the sum of the data divided by the number of data
8383
points. It is commonly called "the average", although it is only one of many
@@ -122,7 +122,7 @@ However, for reading convenience, most of the examples show sorted sequences.
122122
Convert *data* to floats and compute the arithmetic mean.
123123

124124
This runs faster than the :func:`mean` function and it always returns a
125-
:class:`float`. The *data* may be a sequence or iterator. If the input
125+
:class:`float`. The *data* may be a sequence or iterable. If the input
126126
dataset is empty, raises a :exc:`StatisticsError`.
127127

128128
.. doctest::
@@ -143,7 +143,7 @@ However, for reading convenience, most of the examples show sorted sequences.
143143

144144
Raises a :exc:`StatisticsError` if the input dataset is empty,
145145
if it contains a zero, or if it contains a negative value.
146-
The *data* may be a sequence or iterator.
146+
The *data* may be a sequence or iterable.
147147

148148
No special efforts are made to achieve exact results.
149149
(However, this may change in the future.)
@@ -158,7 +158,7 @@ However, for reading convenience, most of the examples show sorted sequences.
158158

159159
.. function:: harmonic_mean(data)
160160

161-
Return the harmonic mean of *data*, a sequence or iterator of
161+
Return the harmonic mean of *data*, a sequence or iterable of
162162
real-valued numbers.
163163

164164
The harmonic mean, sometimes called the subcontrary mean, is the
@@ -202,7 +202,7 @@ However, for reading convenience, most of the examples show sorted sequences.
202202

203203
Return the median (middle value) of numeric data, using the common "mean of
204204
middle two" method. If *data* is empty, :exc:`StatisticsError` is raised.
205-
*data* can be a sequence or iterator.
205+
*data* can be a sequence or iterable.
206206

207207
The median is a robust measure of central location and is less affected by
208208
the presence of outliers. When the number of data points is odd, the
@@ -231,7 +231,7 @@ However, for reading convenience, most of the examples show sorted sequences.
231231
.. function:: median_low(data)
232232

233233
Return the low median of numeric data. If *data* is empty,
234-
:exc:`StatisticsError` is raised. *data* can be a sequence or iterator.
234+
:exc:`StatisticsError` is raised. *data* can be a sequence or iterable.
235235

236236
The low median is always a member of the data set. When the number of data
237237
points is odd, the middle value is returned. When it is even, the smaller of
@@ -251,7 +251,7 @@ However, for reading convenience, most of the examples show sorted sequences.
251251
.. function:: median_high(data)
252252

253253
Return the high median of data. If *data* is empty, :exc:`StatisticsError`
254-
is raised. *data* can be a sequence or iterator.
254+
is raised. *data* can be a sequence or iterable.
255255

256256
The high median is always a member of the data set. When the number of data
257257
points is odd, the middle value is returned. When it is even, the larger of
@@ -272,7 +272,7 @@ However, for reading convenience, most of the examples show sorted sequences.
272272

273273
Return the median of grouped continuous data, calculated as the 50th
274274
percentile, using interpolation. If *data* is empty, :exc:`StatisticsError`
275-
is raised. *data* can be a sequence or iterator.
275+
is raised. *data* can be a sequence or iterable.
276276

277277
.. doctest::
278278

@@ -381,7 +381,7 @@ However, for reading convenience, most of the examples show sorted sequences.
381381

382382
.. function:: pvariance(data, mu=None)
383383

384-
Return the population variance of *data*, a non-empty sequence or iterator
384+
Return the population variance of *data*, a non-empty sequence or iterable
385385
of real-valued numbers. Variance, or second moment about the mean, is a
386386
measure of the variability (spread or dispersion) of data. A large
387387
variance indicates that the data is spread out; a small variance indicates

Lib/statistics.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -744,7 +744,7 @@ def variance(data, xbar=None):
744744
def pvariance(data, mu=None):
745745
"""Return the population variance of ``data``.
746746
747-
data should be a sequence or iterator of Real-valued numbers, with at least one
747+
data should be a sequence or iterable of Real-valued numbers, with at least one
748748
value. The optional argument mu, if given, should be the mean of
749749
the data. If it is missing or None, the mean is automatically calculated.
750750

0 commit comments

Comments
 (0)