From e41ae320ac16a1a5bdf47bf0941a8fadfbf097ff Mon Sep 17 00:00:00 2001 From: Eh2406 Date: Mon, 18 Dec 2017 12:14:24 -0500 Subject: [PATCH] Add to docs --- src/lib.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 22d9ff2..df5ec87 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -14,6 +14,14 @@ //! Everything is calculated iteratively in a single pass using constant memory, //! so the sequence of numbers can be an iterator. The used algorithms try to //! avoid numerical instabilities. +//! +//! If you want [Serde](https://github.com/serde-rs/serde) support, +//! include `"serde"` in your list of features. +//! +//! > Note that deserializing does not currently check for all invalid inputs. +//! For example if you deserialize a corrupted [`Variance`] it may return +//! a negative value for variance, even though that is mathematically impossible. +//! In a future miner release some of these checks may be added. //! //! //! ### Example