doc(spansy): mention that quotes aren't captures in JSON string span

tlsnotary · Feb 8, 2024 · 17f1488 · 17f1488
1 parent c1990bf
commit 17f1488
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/spansy/src/json/types.rs b/spansy/src/json/types.rs
@@ -229,7 +229,9 @@ pub struct Number(pub(crate) Span<str>);
 
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
-/// A string value.
+/// A JSON string value.
+///
+/// This span does not capture the quotation marks around the string.
 pub struct String(pub(crate) Span<str>);
 
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]