docs: add Attributes docs

tomcur · May 19, 2024 · 2a92fa5 · 2a92fa5
1 parent 548ef87
commit 2a92fa5
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/ir_markup.rs b/src/ir_markup.rs
@@ -20,6 +20,8 @@ pub enum Error {
 
 pub type Result<T> = std::result::Result<T, Error>;
 
+/// Block element attributes. This struct keeps attributes ordered deterministically by their key.
+/// Equality of attribute structs is invariant over key insertion order.
 #[derive(Clone, Debug)]
 pub struct Attributes<'s> {
     attributes: Vec<(Cow<'s, str>, AttributeValue<'s>)>,