andreacavalli/rust-average
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Vinzent Steinberg 2017-06-21 19:34:51 +02:00
parent f698e4dc50
commit fd72100913
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/lib.rs
View File

@ -1,11 +1,12 @@
//! This crate provides estimators for statistics on a sequence of numbers. The //! This crate provides estimators for statistics on a sequence of numbers. The
//! typical workflow looks like this: //! typical workflow looks like this:
//! //!
//! 1. Initialize the estimator of your choice with `new()`. //! 1. If necessary, build your custom estimator using [`concatenate`].
//! 2. Add some subset (called "sample") of the sequence of numbers (called //! 2. Initialize the estimator of your choice with `new()`.
//! 3. Add some subset (called "sample") of the sequence of numbers (called
//! "population") for which you want to estimate the statistic, using `add()` //! "population") for which you want to estimate the statistic, using `add()`
//! or `collect()`. //! or `collect()`.
//! 3. Calculate the statistic with `mean()` or similar. //! 4. Calculate the statistic with `mean()` or similar.
//! //!
//! 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()`.