From 6171ada22abe93924650ab31f6b39d74f33bfe49 Mon Sep 17 00:00:00 2001
From: Smitty <me@smitop.com>
Date: Sat, 25 Dec 2021 18:30:10 -0500
Subject: [PATCH] add note about serde traits

---
 src/lib.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index b38105e..993dca6 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,11 @@
 //! Rust library for Wikidata. It has some support for Wikibase as well, although the main focus is
 //! 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(missing_docs)]