From fcbe51f1dd4f82443caba48a5a952c106c8c4f8e Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Fri, 6 Jul 2018 13:08:33 +0200 Subject: [PATCH] Improve Histogram docs by exporting the Histogram10 special case --- src/lib.rs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 5c042af..9088732 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -63,7 +63,9 @@ //! ## Calculating histograms //! //! The [`define_histogram`] macro can be used to define a histogram struct that -//! uses constant memory. +//! uses constant memory. See [`Histogram10`] (defined using +//! `define_histogram!(Histogram10, 10)`) and the extension trait [`Histogram`] +//! for the methods available to the generated struct. //! //! //! [`Mean`]: ./struct.Mean.html @@ -78,6 +80,8 @@ //! [`Max`]: ./struct.Max.html //! [`concatenate`]: ./macro.concatenate.html //! [`define_histogram`]: ./macro.define_histogram.html +//! [`Histogram10`]: ./struct.Histogram10.html +//! [`Histogram`]: ./trait.Histogram.html #![cfg_attr(feature = "cargo-clippy", allow(float_cmp))] @@ -104,3 +108,5 @@ pub use weighted_mean::{WeightedMean, WeightedMeanWithError}; pub use minmax::{Min, Max}; pub use quantile::Quantile; pub use traits::{Estimate, Merge, Histogram}; + +define_histogram!(Histogram10, 10);