Improve docs

This commit is contained in:
Vinzent Steinberg 2017-05-22 18:47:46 +02:00
parent 5c5fdcea55
commit 262d5c88da

View File

@ -2,17 +2,20 @@
//! sequence of numbers, and for their standard errors. The typical workflow //! sequence of numbers, and for their standard errors. The typical workflow
//! looks like this: //! looks like this:
//! //!
//! 1. Initialize your estimator of choice (`Average` or `WeightedAverage`) with //! 1. Initialize your estimator of choice ([`Average`] or [`WeightedAverage`])
//! `new()`. //! with `new()`.
//! 2. Add some subset (called "samples") of the sequence of numbers (called //! 2. Add some subset (called "samples") of the sequence of numbers (called
//! "population") for which you want to estimate the average, using `add()` //! "population") for which you want to estimate the average, using `add()`
//! or `collect()`. //! or `collect()`.
//! 3. Calculate the arithmetic mean with `mean()` and its standard error with //! 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 //! You can run several estimators in parallel and merge them into one with
//! `merge()`. //! `merge()`.
//! //!
//! [`Average`]: ./average/struct.Average.html
//! [`WeightedAverage`]: ./weighted_average/struct.WeightedAverage.html
//!
//! ## Example //! ## Example
//! //!
//! ``` //! ```