Updated CHANGELOG.md with info on all new cmd2.Cmd parameters

Author: tleonhardt

CHANGELOG.md

@@ -28,10 +28,25 @@ shell, and the option for a persistent bottom bar that can display realtime stat
         - Removed `cmd2.Cmd.async_refresh_prompt` and `cmd2.Cmd.need_prompt_refresh` as they are no
           longer needed
 - Enhancements
-    - New optional persistent **bottom toolbar** capable of displaying realtime status information,
-      see the `bottom_toolbar` optional argument to the initializer for `cmd2.Cmd` and the
-      `cmd2.Cmd2.get_bottom_toolbar` method that can be overridden as well as the updated
-      `getting_started.py` example
+    - New `cmd2.Cmd` parameters
+        - **auto_suggest**: (boolean) if `True`, provide fish shell style auto-suggestions. These
+          are grayed-out hints based on history. User can press right-arrow key to accept the
+          provided suggestion.
+        - **bottom toolbar**: (boolean) if `True`, present a persistent bottom toolbar capable of
+          displaying realtime status information while the prompt is displayed, see the
+          `cmd2.Cmd2.get_bottom_toolbar` method that can be overridden as well as the updated
+          `getting_started.py` example
+        - **complete_style**: (enum) style of prompt-toolkit tab completion to use, 3 valid options
+          are:
+            -   1. `CompleteStyle.COLUMN` (default) - displays hints with help next to them in one
+                   big column
+            -   2. `CompleteStyle.MULTI_COLUMN` - displays hints across multiple columns, with help
+                   when selected
+            -   3. `CompleteStyle.READLINE_LIKE` - displays like readline; WARNING:
+                   `complete_in_thread` doesn't work for background completion when this option is
+                   selected
+        - **max_column_completion_items**: (int) the maximum number of completion results to display
+          in a single column, used to provide the initial value for a settable with the same name
     - Added `cmd2.Cmd._in_prompt` flag that is set to `True` when the prompt is displayed and the
       application is waiting for user input
     - Added `cmd2.Cmd.pre_prompt` hook method that is called before the prompt is displayed, but

cmd2/cmd2.py

@@ -351,7 +351,7 @@ def __init__(
         :param include_py: should the "py" command be included for an embedded Python shell
         :param intro: introduction to display at startup
         :param max_column_completion_items: The maximum number of completion results to display in a single column,
-                                            used to provide the initial value for a settable with the same name.
+                                            used to provide the initial value for a settable with the same name
         :param multiline_commands: list of commands allowed to accept multi-line input
         :param persistent_history_file: file path to load a persistent cmd2 command history from
         :param persistent_history_length: max number of history items to write
@@ -478,6 +478,7 @@ def _(event: Any) -> None:  # pragma: no cover
         try:
             self.session: PromptSession[str] = PromptSession(
                 auto_suggest=self.auto_suggest,
+                bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                 complete_in_thread=True,
                 complete_style=complete_style,
                 complete_while_typing=False,
@@ -492,6 +493,7 @@ def _(event: Any) -> None:  # pragma: no cover
             # where isatty() is True but there is no real console.
             self.session = PromptSession(
                 auto_suggest=self.auto_suggest,
+                bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                 complete_in_thread=True,
                 complete_style=complete_style,
                 complete_while_typing=False,
@@ -3409,29 +3411,29 @@ def get_prompt() -> ANSI | str:
                             history_to_use.append_string(item)
 
                         temp_session1: PromptSession[str] = PromptSession(
+                            complete_style=self.session.complete_style,
+                            complete_while_typing=self.session.complete_while_typing,
                             history=history_to_use,
                             input=self.session.input,
-                            output=self.session.output,
                             lexer=self.lexer,
-                            complete_style=self.session.complete_style,
-                            complete_while_typing=self.session.complete_while_typing,
+                            output=self.session.output,
                         )
 
                         return temp_session1.prompt(
                             prompt_to_use,
+                            bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                             completer=completer_to_use,
                             lexer=self.lexer,
                             pre_run=self.pre_prompt,
-                            bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                         )
 
                     # history is None
                     return self.session.prompt(
                         prompt_to_use,
+                        bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                         completer=completer_to_use,
                         lexer=self.lexer,
                         pre_run=self.pre_prompt,
-                        bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
                     )
 
             # Otherwise read from self.stdin
@@ -3446,24 +3448,24 @@ def get_prompt() -> ANSI | str:
                 )
                 line = temp_session2.prompt(
                     prompt,
-                    pre_run=self.pre_prompt,
                     bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
+                    pre_run=self.pre_prompt,
                 )
                 if len(line) == 0:
                     raise EOFError
                 return line.rstrip('\n')
             else:
                 # not a tty, just read the line
                 temp_session3: PromptSession[str] = PromptSession(
-                    input=self.session.input,
-                    output=self.session.output,
-                    lexer=self.lexer,
                     complete_style=self.session.complete_style,
                     complete_while_typing=self.session.complete_while_typing,
+                    input=self.session.input,
+                    lexer=self.lexer,
+                    output=self.session.output,
                 )
                 line = temp_session3.prompt(
-                    pre_run=self.pre_prompt,
                     bottom_toolbar=self.get_bottom_toolbar if self.bottom_toolbar else None,
+                    pre_run=self.pre_prompt,
                 )
                 if len(line) == 0:
                     raise EOFError