From 837b923d31efb9dc384c79ea0e0834c7e692e234 Mon Sep 17 00:00:00 2001
From: sholderbach <sholderbach@users.noreply.github.com>
Date: Fri, 21 Jul 2023 11:30:03 +0200
Subject: [PATCH] Make `Style.with_reset` more explicit as `prefix_with_reset`

As the behavior is probably a bit unclear and everybody constructing or
destructuring it by hand will now have to take this field into account
we should be as explicit as possible. @fdncred 's suggestion was
`prefix_with_reset`.
I also tried to be even more detailed in the fields docstring for
anybody interacting it after `0.47.0`. @alexkunde check me if I am wrong
here.
---
 src/ansi.rs    |  2 +-
 src/style.rs   | 14 +++++++-------
 tests/style.rs |  2 +-
 3 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/ansi.rs b/src/ansi.rs
index 901e160..c153da8 100644
--- a/src/ansi.rs
+++ b/src/ansi.rs
@@ -14,7 +14,7 @@ impl Style {
         }
 
         // Prefix everything with reset characters if needed
-        if self.with_reset {
+        if self.prefix_with_reset {
             write!(f, "\x1B[0m")?
         }
 
diff --git a/src/style.rs b/src/style.rs
index 154028d..3058767 100644
--- a/src/style.rs
+++ b/src/style.rs
@@ -45,8 +45,8 @@ pub struct Style {
     /// Whether this style is struckthrough.
     pub is_strikethrough: bool,
 
-    /// Wether this style starts with reset code
-    pub with_reset: bool,
+    /// Wether this style is always displayed starting with a reset code to clear any remaining style artifacts
+    pub prefix_with_reset: bool,
 }
 
 impl Style {
@@ -64,7 +64,7 @@ impl Style {
         Style::default()
     }
 
-    /// Returns a `Style` with the reset_before_style property set.
+    /// Returns a [`Style`] with the `Style.prefix_with_reset` property set.
     ///
     /// # Examples
     ///
@@ -76,7 +76,7 @@ impl Style {
     /// ```
     pub const fn reset_before_style(&self) -> Style {
         Style {
-            with_reset: true,
+            prefix_with_reset: true,
             ..*self
         }
     }
@@ -289,7 +289,7 @@ impl Default for Style {
             is_reverse: false,
             is_hidden: false,
             is_strikethrough: false,
-            with_reset: false,
+            prefix_with_reset: false,
         }
     }
 }
@@ -577,7 +577,7 @@ impl Color {
     pub fn reset_before_style(self) -> Style {
         Style {
             foreground: Some(self),
-            with_reset: true,
+            prefix_with_reset: true,
             ..Style::default()
         }
     }
@@ -659,6 +659,6 @@ mod serde_json_tests {
     fn style_serialization() {
         let style = Style::default();
 
-        assert_eq!(serde_json::to_string(&style).unwrap(), "{\"foreground\":null,\"background\":null,\"is_bold\":false,\"is_dimmed\":false,\"is_italic\":false,\"is_underline\":false,\"is_blink\":false,\"is_reverse\":false,\"is_hidden\":false,\"is_strikethrough\":false,\"with_reset\":false}".to_string());
+        assert_eq!(serde_json::to_string(&style).unwrap(), "{\"foreground\":null,\"background\":null,\"is_bold\":false,\"is_dimmed\":false,\"is_italic\":false,\"is_underline\":false,\"is_blink\":false,\"is_reverse\":false,\"is_hidden\":false,\"is_strikethrough\":false,\"prefix_with_reset\":false}".to_string());
     }
 }
diff --git a/tests/style.rs b/tests/style.rs
index e0c5202..9d58340 100644
--- a/tests/style.rs
+++ b/tests/style.rs
@@ -22,7 +22,7 @@ fn manual_instance_style() {
         is_reverse: false,
         is_hidden: false,
         is_strikethrough: false,
-        with_reset: false,
+        prefix_with_reset: false,
     };
     assert_eq!(Style::default(), s);
 }