Skip to content
This repository was archived by the owner on Feb 20, 2026. It is now read-only.

Commit 4c99288

Browse files
committed
Update documentation
1 parent a06e63f commit 4c99288

3 files changed

Lines changed: 7 additions & 4 deletions

File tree

cli_ui/__init__.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -503,10 +503,9 @@ def ask_choice(
503503
504504
Will loop until:
505505
* the user enters a valid index
506-
* or hits ``ctrl-c``
507506
* or leaves the prompt empty
508507
509-
In the last two cases, None will be returned
508+
In the last case, None will be returned
510509
"""
511510
if func_desc is None:
512511
func_desc = lambda x: str(x)

docs/changelog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ v0.7.1
7979
++++++
8080

8181
* Fix crash in ``ask_password`` when password was empty.
82-
* Let the ``KeyboardInterrput`` exception propagate back to the caller instead of catching
82+
* Let the :py:exc:`KeyboardInterrupt`` exception propagate back to the caller instead of catching
8383
it ourselves and returning ``None``. Reported by Théo Delrieu.
8484

8585
v0.7.0

docs/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ Progress messages
197197

198198
::
199199

200-
>>> for in in rang(0, 5):
200+
>>> for in in range(0, 5):
201201
>>> cli_ui.dot()
202202
....<no newline>
203203
>>> cli_ui.dot(last=True)
@@ -297,6 +297,10 @@ Asking for user input
297297

298298
``choices`` is now a named keyword argument
299299

300+
.. versionchanged:: 0.7
301+
302+
The :py:exc:`KeyboardInterrupt` exception is no longer caught by this function.
303+
300304

301305
.. autofunction:: ask_yes_no
302306

0 commit comments

Comments
 (0)