docs: Clarify role of StyledStr

clap-rs · Dec 15, 2022 · 16c499c · 16c499c
1 parent 1f3d5a3
commit 16c499c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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")]