add note about serde traits

This commit is contained in:
Smitty 2021-12-25 18:30:10 -05:00
parent 793e5ec218
commit 6171ada22a

View file

@ -1,5 +1,11 @@
//! Rust library for Wikidata. It has some support for Wikibase as well, although the main focus is //! Rust library for Wikidata. It has some support for Wikibase as well, although the main focus is
//! supporting the Wikidata instance. //! supporting the Wikidata instance.
//!
//! ## A note on serialization
//! Many items in this crate implement [`serde::Serialize`] and [`serde::Deserialize`]. Note that
//! the JSON serialization of entities provided by these traits is not the same as the
//! serialization used by Wikidata in data dumps and `Special:EntityData`, but is instead a
//! serialization specific to this crate.
#![warn(clippy::pedantic)] #![warn(clippy::pedantic)]
#![warn(missing_docs)] #![warn(missing_docs)]