cleanup.

Author: jonathanslenders

src/prompt_toolkit/shortcuts/choice_input.py

@@ -53,6 +53,16 @@ class ChoiceInput(Generic[_T]):
         considered the default.
     :param mouse_support: Enable mouse support.
     :param style: :class:`.Style` instance for the color scheme.
+    :param symbol: Symbol to be displayed in front of the selected choice.
+    :param show_frame: `bool` or
+        :class:`~prompt_toolkit.filters.Filter`. When True, surround the input
+        with a frame.
+    :param enable_interrupt: `bool` or
+        :class:`~prompt_toolkit.filters.Filter`. When True, raise
+        the ``interrupt_exception`` (``KeyboardInterrupt`` by default) when
+        control-c has been pressed.
+    :param interrupt_exception: The exception type that will be raised when
+        there is a keyboard interrupt (control-c keypress).
     """
 
     def __init__(
@@ -66,7 +76,7 @@ def __init__(
         symbol: str = ">",
         show_frame: FilterOrBool = False,
         enable_suspend: FilterOrBool = False,
-        enable_abort: FilterOrBool = True,
+        enable_interrupt: FilterOrBool = True,
         interrupt_exception: type[BaseException] = KeyboardInterrupt,
     ) -> None:
         if style is None:
@@ -81,7 +91,7 @@ def __init__(
         self.show_frame = show_frame
         self.enable_suspend = enable_suspend
         self.interrupt_exception = interrupt_exception
-        self.enable_abort = enable_abort
+        self.enable_interrupt = enable_interrupt
 
     def _create_application(self) -> Application[_T]:
         radio_list = RadioList(
@@ -139,11 +149,11 @@ def _accept_input(event: E) -> None:
             event.app.exit(result=radio_list.current_value, style="class:accepted")
 
         @Condition
-        def enable_abort() -> bool:
-            return to_filter(self.enable_abort)()
+        def enable_interrupt() -> bool:
+            return to_filter(self.enable_interrupt)()
 
-        @kb.add("c-c", filter=enable_abort)
-        @kb.add("<sigint>", filter=enable_abort)
+        @kb.add("c-c", filter=enable_interrupt)
+        @kb.add("<sigint>", filter=enable_interrupt)
         def _keyboard_interrupt(event: E) -> None:
             "Abort when Control-C has been pressed."
             event.app.exit(exception=self.interrupt_exception(), style="class:aborting")
@@ -185,7 +195,7 @@ def choice(
     symbol: str = ">",
     show_frame: bool = False,
     enable_suspend: FilterOrBool = False,
-    enable_abort: FilterOrBool = True,
+    enable_interrupt: FilterOrBool = True,
     interrupt_exception: type[BaseException] = KeyboardInterrupt,
 ) -> _T:
     """
@@ -220,6 +230,6 @@ def choice(
         symbol=symbol,
         show_frame=show_frame,
         enable_suspend=enable_suspend,
-        enable_abort=enable_abort,
+        enable_interrupt=enable_abort,
         interrupt_exception=interrupt_exception,
     ).prompt()

src/prompt_toolkit/shortcuts/prompt.py

@@ -320,6 +320,9 @@ class PromptSession(Generic[_T]):
         yet. Unlike the `default` parameter, this won't be returned as part of
         the output ever. This can be formatted text or a callable that returns
         formatted text.
+    :param show_frame: `bool` or
+        :class:`~prompt_toolkit.filters.Filter`. When True, surround the input
+        with a frame.
     :param refresh_interval: (number; in seconds) When given, refresh the UI
         every so many seconds.
     :param input: `Input` object. (Note that the preferred way to change the