DOC: formatted key-value list as a table and added some latex math

phobson · phobson · commit 5ba30aadab2c · 2014-02-17T07:21:21.000-08:00
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -1884,22 +1884,29 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, labels=None):
     -------
     bxpstats : A list of dictionaries containing the results for each column
         of data. Keys of each dictionary are the following:
-         - label = tick label for the boxplot
-         - mean = mean value (can plot as a line or point)
-         - median = 50th percentile
-         - q1 = first quartile (25th pctl)
-         - q3 = third quartile (75 (pctl)
-         - cilo = lower notch around the median
-         - ciho = upper notch around the median
-         - whislo = end of the lower whisker
-         - whishi = end of the upper whisker
-         - fliers = outliers
+
+        ========   ===================================
+        Key        Value Description
+        ========   ===================================
+        label      tick label for the boxplot
+        mean       arithemetic mean value
+        median     50th percentile
+        q1         first quartile (25th percentile)
+        q3         third quartile (75th percentile)
+        cilo       lower notch around the median
+        ciho       upper notch around the median
+        whislo     end of the lower whisker
+        whishi     end of the upper whisker
+        fliers     outliers
+        ========   ===================================
 
 
     Notes
     -----
     Non-bootstrapping approach to confidence interval uses Gaussian-based
-    asymptotic approximation.
+    asymptotic approximation:
+
+    .. math:: \mathrm{med} \pm 1.57 \times \frac{\mathrm{iqr}}{\sqrt{N}}
 
     General approach from:
     McGill, R., Tukey, J.W., and Larsen, W.A. (1978) "Variations of
