From 16c499c7b385638b155c0bd4b20bcfe94e552be4 Mon Sep 17 00:00:00 2001
From: Ed Page <eopage@gmail.com>
Date: Wed, 14 Dec 2022 19:29:01 -0600
Subject: [PATCH] docs: Clarify role of StyledStr

---
 src/builder/styled_str.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/builder/styled_str.rs b/src/builder/styled_str.rs
index ecd05a359d0..d36329dee3f 100644
--- a/src/builder/styled_str.rs
+++ b/src/builder/styled_str.rs
@@ -1,4 +1,7 @@
 /// Terminal-styling container
+///
+/// For now, this is the same as a [`Str`][crate::builder::Str].  This exists to reserve space in
+/// the API for exposing terminal styling.
 #[derive(Clone, Default, Debug, PartialEq, Eq)]
 pub struct StyledStr {
     #[cfg(feature = "color")]