docs

Author: jonathanslenders

docs/images/choice-input.png

@@ -69,7 +69,7 @@ Table of contents
    pages/upgrading/index
    pages/printing_text
    pages/asking_for_input
-   pages/choice_prompts
+   pages/asking_for_a_choice
    pages/dialogs
    pages/progress_bars
    pages/full_screen_apps

docs/images/choice-with-frame.png

@@ -13,26 +13,26 @@ from a list of options:
     from prompt_toolkit.shortcuts import choice
 
     result = choice(
-        message="Please choose a dish",
+        message="Please choose a dish:",
         options=[
             ("pizza", "Pizza with mushrooms"),
             ("salad", "Salad with tomatoes"),
             ("sushi", "Sushi"),
         ],
         default="salad",
     )
+    print(f"You have chosen: {result}")
 
-    print(f"You have chosen: {text}")
+.. image:: ../images/choice-input.png
 
 
 Coloring the options
 --------------------
 
-Similar to text input prompts, it is possible to customize the colors and
-styles. The ``message`` parameter takes any :ref:`formatted text
-<formatted_text>`, and the labels (2nd argument of the options) can also be
-:ref:`formatted text <formatted_text>`. Further, we can pass a
-:class:`~prompt_toolkit.styles.Style` instance using the
+It is possible to customize the colors and styles. The ``message`` parameter
+takes any :ref:`formatted text <formatted_text>`, and the labels (2nd argument
+from the options) can be :ref:`formatted text <formatted_text>` as well.
+Further, we can pass a :class:`~prompt_toolkit.styles.Style` instance using the
 :meth:`~prompt_toolkit.styles.Style.from_dict` function:
 
 .. code:: python
@@ -48,7 +48,6 @@ styles. The ``message`` parameter takes any :ref:`formatted text
             "input-selection": "fg:#ff0000",
             "number": "fg:#884444 bold",
             "selected-option": "underline",
-            "frame.border": "#884444",
         }
     )
 
@@ -66,15 +65,17 @@ styles. The ``message`` parameter takes any :ref:`formatted text
     )
     print(result)
 
+.. image:: ../images/colored-choice.png
+
 
 Adding a frame
 --------------
 
 The :func:`~prompt_toolkit.shortcuts.choice` function takes a
-``show_frame`` argument. When set to ``True``, the options will be shown
-inside a frame. It is also possible to pass a :ref:`filter <filters>`, like
-``~is_done``, so that the frame is only displayed when asking for input, but
-hidden once the input is accepted.
+``show_frame`` argument. When ``True``, the input is displayed within a frame.
+It is also possible to pass a :ref:`filter <filters>`, like ``~is_done``, so
+that the frame is only displayed when asking for input, but hidden once the
+input is accepted.
 
 .. code:: python
 
@@ -85,7 +86,7 @@ hidden once the input is accepted.
     style = Style.from_dict(
         {
             "frame.border": "#884444",
-            "selected-option": "bold underline",
+            "selected-option": "bold",
         }
     )
     result = choice(
@@ -100,4 +101,4 @@ hidden once the input is accepted.
     )
     print(result)
 
-
+.. image:: ../images/choice-with-frame.png

docs/images/colored-choice.png

@@ -96,7 +96,7 @@ Shortcuts
     :members: prompt, PromptSession, confirm, CompleteStyle,
         create_confirm_session, clear, clear_title, print_formatted_text,
         set_title, ProgressBar, input_dialog, message_dialog, progress_dialog,
-        radiolist_dialog, yes_no_dialog, button_dialog, select_input
+        radiolist_dialog, yes_no_dialog, button_dialog, choice
 
 .. automodule:: prompt_toolkit.shortcuts.progress_bar.formatters
     :members: