📝 Add notice about the stability of the Styled option

MystPi · Apr 6, 2024 · 7e86154 · 7e86154
1 parent 7cfeafd
commit 7e86154
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/pprint.gleam b/src/pprint.gleam
@@ -26,6 +26,10 @@ pub type Config {
 ///
 pub type StyleMode {
   /// Data structures are styled with ANSI style codes.
+  ///
+  /// > ⚠️ **WARNING:** Styling is subject to change *without* a major release!
+  /// This means that this option should only be used for debugging purposes and
+  /// *should not* be used in tests.
   Styled
   /// Everything remains unstyled.
   Unstyled
@@ -107,6 +111,10 @@ pub fn format(value: a) -> String {
 /// ```
 /// This function behaves identically on both targets.
 ///
+/// > ⚠️ **WARNING:** Styling is subject to change *without* a major release!
+/// This means that this function should only be used for debugging purposes and
+/// *should not* be used in tests.
+///
 pub fn styled(value: a) -> String {
   with_config(value, Config(Styled, BitArraysAsString, NoLabels))
 }