From 6f9f6075e0046d2109ca62c228a505fe0465cc81 Mon Sep 17 00:00:00 2001 From: pantonshire Date: Sat, 18 Nov 2023 16:11:31 +0000 Subject: [PATCH] documentation for internal CowCappedString --- enumscribe/src/internal/capped_string.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/enumscribe/src/internal/capped_string.rs b/enumscribe/src/internal/capped_string.rs index d6d5b7f..d2afc81 100644 --- a/enumscribe/src/internal/capped_string.rs +++ b/enumscribe/src/internal/capped_string.rs @@ -3,11 +3,11 @@ use core::{str, ops::Deref, borrow::Borrow, fmt}; -/// TODO: documentation +/// A string type which is either borrowed or stores up to `N` bytes of string data inline. pub enum CowCappedString<'a, const N: usize> { - /// TODO: documentation + /// A reference to string data stored elsewhere. Borrowed(&'a str), - /// TODO: documentation + /// The string data is stored inline. Owned(CappedString), }