Improve documentation.

[pyutils.git] / docs / pyutils.typez.rst

diff --git a/docs/pyutils.typez.rst b/docs/pyutils.typez.rst
index f96b7e29876f71c06d544b2590cd14efd7012f28..5f33cd42a0b750000c5ff1b5169dde0c48ecb2fc 100644 (file)
--- a/docs/pyutils.typez.rst
+++ b/docs/pyutils.typez.rst
@@ -15,6 +15,32 @@ pyutils.typez.centcount module
 pyutils.typez.histogram module
 ------------------------------
 
+A Histogram helper class.  Creates outputs like this::
+
+      [4..5): ▏                                                     ( 0.16% n=1)
+      [5..6): ██▍                                                   ( 0.64% n=4)
+      [6..7): ██████▏                                               ( 1.60% n=10)
+      [7..8): ████████████▍                                         ( 3.20% n=20)
+      [8..9): █████████████████████▊                                ( 5.60% n=35)
+     [9..10): ████████████████████████████████▍                     ( 8.32% n=52)
+    [10..11): ██████████████████████████████████████████▍           (10.88% n=68)
+    [11..12): █████████████████████████████████████████████████▉    (12.80% n=80)
+    [12..13): ████████████████████████████████████████████████████▉ (13.60% n=85)
+    [13..14): █████████████████████████████████████████████████▉    (12.80% n=80)
+    [14..15): ██████████████████████████████████████████▍           (10.88% n=68)
+    [15..16): ████████████████████████████████▍                     ( 8.32% n=52)
+    [16..17): █████████████████████▊                                ( 5.60% n=35)
+    [17..18): ████████████▍                                         ( 3.20% n=20)
+    [18..19): ██████▏                                               ( 1.60% n=10)
+    [19..20): ██▍                                                   ( 0.64% n=4)
+    [20..21): ▏                                                     ( 0.16% n=1)
+    --------------------------------------------------------------------------------
+     [4..21):                                                         pop(Σn)=625
+                                                                      mean(x̄)=12.000
+                                                                  median(p50)=12.000
+                                                                     mode(Mo)=12.000
+                                                                     stdev(σ)=0.113
+
 .. automodule:: pyutils.typez.histogram
    :members:
    :undoc-members: