From c21ecd9b6d438b5b83d2deca1cfdfd8b4a610369 Mon Sep 17 00:00:00 2001 From: Florian Jacob Date: Tue, 22 Oct 2019 23:44:18 +0200 Subject: [PATCH] Add more documentation to vec_as_map_of_empty --- src/lib.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 1b6ac335..8dbccc4c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -880,7 +880,11 @@ where /// Serde serialization and deserialization functions that map a `Vec` to a `HashMap`. /// -/// To be used as `#[serde(with = "vec_as_map_of_empty")]` +/// The Matrix spec sometimes specifies lists as hash maps so the list entries can be expanded with +/// attributes without breaking compatibility. As that would be a breaking change for ruma's event +/// types anyway, we convert them to `Vec`s for simplicity, using this module. +/// +/// To be used as `#[serde(with = "vec_as_map_of_empty")]`. mod vec_as_map_of_empty { use super::Empty; use serde::{Deserialize, Deserializer, Serialize, Serializer};