Update documentation

Author: dmerejkowsky

cli_ui/__init__.py

@@ -501,17 +501,21 @@ def ask_choice(
 ) -> Any:
     """Ask the user to choose from a list of choices.
 
-    :return: the selected choice
-
-    ``func_desc`` will be called on every list item for displaying
-    and sorting the list. If not given, will default to
-    the identity function.
-
     Will loop until:
         * the user enters a valid index
         * or leaves the prompt empty
 
-    In the last case, None will be returned
+    In the last case, `None` will be returned
+
+    :param prompt: a list of tokens suitable for :func:`info`
+    :param choices: a list of arbitrary elements
+    :func_desc: a callable. It will be used to display and
+                sort the list of choices (unless ``sort`` is False)
+                Defaults to the identity function.
+    :sort: whether to sort the list of choices.
+
+    :return: the selected choice.
+
     """
     if func_desc is None:
         func_desc = lambda x: str(x)

docs/index.rst

@@ -293,6 +293,11 @@ Asking for user input
       >>> fruit
       'banana'
 
+
+  .. versionchanged:: 0.10
+
+      Add ``sort`` paramater to disable sorting the list of choices
+
   .. versionchanged:: 0.8
 
       ``choices`` is now a named keyword argument
@@ -320,7 +325,6 @@ Asking for user input
       >>> fav_food = cli_ui.ask_password("Guilty pleasure?")
       :: Guilty pleasure?
       ****
-
       >>> fav_food
       'chocolate'