From cc42012dafe24aa1aa0e0b4f741573a3319e049c Mon Sep 17 00:00:00 2001 From: Jeremy Carbaugh Date: Mon, 19 Sep 2011 14:07:03 -0400 Subject: [PATCH] add class docs to Histogram --- saucebrush/stats.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/saucebrush/stats.py b/saucebrush/stats.py index 796d3fe..94e46e2 100644 --- a/saucebrush/stats.py +++ b/saucebrush/stats.py @@ -179,6 +179,14 @@ class StandardDeviation(StatsFilter): return _stddev(self._values, population) class Histogram(StatsFilter): + """ Generate a basic histogram of the specified field. The value() method + returns a dict of value to occurance count mappings. The __str__ method + generates a basic and limited histogram useful for printing to the + command line. The label_length attribute determines the padding and + cut-off of the basic histogram labels. + + **This filters maintains a dict of unique field values in memory.** + """ label_length = 6