From cae51c61b6601d9d2abb06eff4b0731a34bd0c5c Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Fri, 4 Dec 2015 11:19:26 +0100 Subject: [PATCH] Improve docs for Optional --- src/optional.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/optional.rs b/src/optional.rs index b430b3a..f4c82c6 100644 --- a/src/optional.rs +++ b/src/optional.rs @@ -5,7 +5,8 @@ use rustc_serialize::{Decodable, Decoder}; /// An `Optional` can contain either `Value` or `Absent`. /// It is similar to an `Option`, but `None` will be serialized to `null` -/// while `Absent` means the value will be omitted when serialized. +/// while `Absent` means that both the key and the value will be omitted +/// when serialized. /// /// An `Optional` implements the `Default` trait, it is `Absent` by default. #[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Debug, Hash)]