Updated comments.

Author: kmvanbrunt

cmd2/cmd2.py

@@ -1196,7 +1196,7 @@ def visible_prompt(self) -> str:
         Used by transcript testing to make it easier and more reliable when users are doing things like
         coloring the prompt.
 
-        :return: the stripped prompt.
+        :return: the stripped prompt
         """
         return su.strip_style(self.prompt)
 

cmd2/rich_utils.py

@@ -263,7 +263,7 @@ def rich_text_to_string(text: Text) -> str:
 
 
 def string_to_rich_text(text: str) -> Text:
-    r"""Create a Text object from a string which can contain ANSI style sequences.
+    r"""Create a Rich Text object from a string which can contain ANSI style sequences.
 
     This wraps rich.Text.from_ansi() to handle an issue where it removes the
     trailing line break from a string (e.g. "Hello\n" becomes "Hello").
@@ -327,7 +327,7 @@ def prepare_objects_for_rendering(*objects: Any) -> tuple[Any, ...]:
     """Prepare a tuple of objects for printing by Rich's Console.print().
 
     This function converts any non-Rich object whose string representation contains
-    ANSI style sequences into a rich.Text object. This ensures correct display width
+    ANSI style sequences into a Rich Text object. This ensures correct display width
     calculation, as Rich can then properly parse and account for these non-printing
     codes. All other objects are left untouched, allowing Rich's native
     renderers to handle them.

cmd2/string_utils.py

@@ -96,9 +96,6 @@ def stylize(val: str, style: StyleType) -> str:
 def strip_style(val: str) -> str:
     """Strip all ANSI style sequences from a string.
 
-    This function uses a regular expression to efficiently remove ANSI style
-    sequences, which are a subset of ANSI escape sequences used for text formatting.
-
     :param val: string to be stripped
     :return: the stripped string
     """