Skip to content

Commit

Permalink
Improve docs for Optional
Browse files Browse the repository at this point in the history
  • Loading branch information
dbrgn committed Dec 21, 2015
1 parent 6dc2fdc commit cae51c6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/optional.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ use rustc_serialize::{Decodable, Decoder};

/// An `Optional` can contain either `Value<T>` 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)]
Expand Down

0 comments on commit cae51c6

Please sign in to comment.