]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Issue #27825: Improve for statistics data arguments. (Contributed by Mariatta Wijaya.)
authorRaymond Hettinger <python@rcn.com>
Tue, 22 Nov 2016 00:31:02 +0000 (16:31 -0800)
committerRaymond Hettinger <python@rcn.com>
Tue, 22 Nov 2016 00:31:02 +0000 (16:31 -0800)
Doc/library/statistics.rst

index c020a34ff88a1331ea0491d9b659cbc77d475c25..7a1f74a1b23a7d6dae4451f8ba29ea3c5982d7cb 100644 (file)
@@ -69,8 +69,7 @@ However, for reading convenience, most of the examples show sorted sequences.
 
 .. function:: mean(data)
 
-   Return the sample arithmetic mean of *data*, a sequence or iterator of
-   real-valued numbers.
+   Return the sample arithmetic mean of *data* which can be a sequence or iterator.
 
    The arithmetic mean is the sum of the data divided by the number of data
    points.  It is commonly called "the average", although it is only one of many
@@ -148,6 +147,7 @@ However, for reading convenience, most of the examples show sorted sequences.
 
    Return the median (middle value) of numeric data, using the common "mean of
    middle two" method.  If *data* is empty, :exc:`StatisticsError` is raised.
+   *data* can be a sequence or iterator.
 
    The median is a robust measure of central location, and is less affected by
    the presence of outliers in your data.  When the number of data points is
@@ -175,7 +175,7 @@ However, for reading convenience, most of the examples show sorted sequences.
 .. function:: median_low(data)
 
    Return the low median of numeric data.  If *data* is empty,
-   :exc:`StatisticsError` is raised.
+   :exc:`StatisticsError` is raised.  *data* can be a sequence or iterator.
 
    The low median is always a member of the data set.  When the number of data
    points is odd, the middle value is returned.  When it is even, the smaller of
@@ -195,7 +195,7 @@ However, for reading convenience, most of the examples show sorted sequences.
 .. function:: median_high(data)
 
    Return the high median of data.  If *data* is empty, :exc:`StatisticsError`
-   is raised.
+   is raised.  *data* can be a sequence or iterator.
 
    The high median is always a member of the data set.  When the number of data
    points is odd, the middle value is returned.  When it is even, the larger of
@@ -216,7 +216,7 @@ However, for reading convenience, most of the examples show sorted sequences.
 
    Return the median of grouped continuous data, calculated as the 50th
    percentile, using interpolation.  If *data* is empty, :exc:`StatisticsError`
-   is raised.
+   is raised.  *data* can be a sequence or iterator.
 
    .. doctest::