From 262d5c88da9647e519009aa7a2e760f1d996dbbe Mon Sep 17 00:00:00 2001 From: Vinzent Steinberg Date: Mon, 22 May 2017 18:47:46 +0200 Subject: [PATCH] Improve docs --- src/lib.rs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 02f5d18..897f9f4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,17 +2,20 @@ //! sequence of numbers, and for their standard errors. The typical workflow //! looks like this: //! -//! 1. Initialize your estimator of choice (`Average` or `WeightedAverage`) with -//! `new()`. +//! 1. Initialize your estimator of choice ([`Average`] or [`WeightedAverage`]) +//! with `new()`. //! 2. Add some subset (called "samples") of the sequence of numbers (called //! "population") for which you want to estimate the average, using `add()` //! or `collect()`. //! 3. Calculate the arithmetic mean with `mean()` and its standard error with -//! `error(). +//! `error()`. //! //! You can run several estimators in parallel and merge them into one with //! `merge()`. //! +//! [`Average`]: ./average/struct.Average.html +//! [`WeightedAverage`]: ./weighted_average/struct.WeightedAverage.html +//! //! ## Example //! //! ```