From bc445db1c945dfb89c52092be7fc34a6fcb0fbed Mon Sep 17 00:00:00 2001 From: Erin Date: Sat, 6 Aug 2022 00:21:47 +0200 Subject: [PATCH] nothing beter to do, added docs for string type --- src/interpreter/value/string.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/interpreter/value/string.rs b/src/interpreter/value/string.rs index 2723328..a5b10fe 100644 --- a/src/interpreter/value/string.rs +++ b/src/interpreter/value/string.rs @@ -1,5 +1,8 @@ use std::{fmt::Display, ops::Deref, rc::Rc}; +/// A Wisp string type which can hold two variants: +/// - Borrowed (usually a reference to source code or built-in literal) +/// - Shared (Ref-counted pointer to [`str`]) #[derive(Debug, Clone)] pub enum Str<'a> { Borrowed(&'a str),