Renamed some functions and updated comments.

Author: kmvanbrunt

cmd2/rich_utils.py

@@ -160,16 +160,16 @@ def __init__(
                 "Passing 'theme' is not allowed. Its behavior is controlled by the global APP_THEME and set_theme()."
             )
 
-        # Store the configuration used to create this console for caching purposes.
-        self._config_key = self._generate_config_key(file=file, **kwargs)
+        # Store the configuration key used by cmd2 to cache this console.
+        self._config_key = self._build_config_key(file=file, **kwargs)
 
         force_terminal: bool | None = None
         force_interactive: bool | None = None
 
         if ALLOW_STYLE == AllowStyle.ALWAYS:
             force_terminal = True
 
-            # Turn off interactive mode if dest is not actually a terminal which supports it
+            # Turn off interactive mode if dest is not a terminal which supports it.
             tmp_console = Console(file=file)
             force_interactive = tmp_console.is_interactive
         elif ALLOW_STYLE == AllowStyle.NEVER:
@@ -184,12 +184,12 @@ def __init__(
         )
 
     @staticmethod
-    def _generate_config_key(
+    def _build_config_key(
         *,
         file: IO[str] | None,
         **kwargs: Any,
     ) -> tuple[Any, ...]:
-        """Generate a key representing the settings used to initialize a console.
+        """Build a key representing the settings used to initialize a console.
 
         This key includes the file identity, global settings (ALLOW_STYLE, APP_THEME),
         and any other settings passed in via kwargs.
@@ -216,7 +216,7 @@ def matches_config(
         :param kwargs: other console settings being checked
         :return: True if the settings match this console's configuration
         """
-        return self._config_key == self._generate_config_key(file=file, **kwargs)
+        return self._config_key == self._build_config_key(file=file, **kwargs)
 
     def on_broken_pipe(self) -> None:
         """Override which raises BrokenPipeError instead of SystemExit."""

examples/async_printing.py

@@ -103,7 +103,7 @@ def _get_alerts(self) -> list[str]:
 
         return alerts
 
-    def _generate_alert_str(self) -> str:
+    def _build_alert_str(self) -> str:
         """Combines alerts into one string that can be printed to the terminal
         :return: the alert string.
         """
@@ -125,8 +125,8 @@ def _generate_alert_str(self) -> str:
 
         return alert_str
 
-    def _generate_colored_prompt(self) -> str:
-        """Randomly generates a colored prompt
+    def _build_colored_prompt(self) -> str:
+        """Randomly builds a colored prompt
         :return: the new prompt.
         """
         rand_num = random.randint(1, 6)
@@ -153,10 +153,10 @@ def _add_alerts_func(self) -> None:
 
         while not self._stop_event.is_set():
             # Get any alerts that need to be printed
-            alert_str = self._generate_alert_str()
+            alert_str = self._build_alert_str()
 
-            # Generate a new prompt
-            new_prompt = self._generate_colored_prompt()
+            # Build a new prompt
+            new_prompt = self._build_colored_prompt()
 
             # Check if we have alerts to print
             if alert_str: