Skip to content

Commit

Permalink
Add a little more crate-level doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dtolnay committed Aug 18, 2019
1 parent 71290bc commit cd162e1
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
//! ```edition2018
//! Find out about keys that are ignored when deserializing data. This crate
//! provides a wrapper that works with any existing Serde `Deserializer` and
//! invokes a callback on every ignored field.
//!
//! You can use this to warn users about extraneous keys in a config file, for
//! example.
//!
//! Note that if you want unrecognized fields to be an error, consider using the
//! `#[serde(deny_unknown_fields)]` [attribute] instead.
//!
//! [attribute]: https://serde.rs/attributes.html
//!
//! # Example
//!
//! ```
//! # use serde_derive::Deserialize;
//! #
//! use serde::Deserialize;
Expand Down

0 comments on commit cd162e1

Please sign in to comment.