Skip to content

Commit e4f4d2b

Browse files
committed
Updated documentation.
1 parent b810c4d commit e4f4d2b

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ prompt is displayed.
5757
- Changed `StatementParser.parse_command_only()` to return a `PartialStatement` object.
5858
- Renamed `Macro.arg_list` to `Macro.args`.
5959
- Removed `terminal_utils.py` since `prompt-toolkit` provides this functionality.
60+
- Replaced `async_alert()` and `async_update_prompt()` with a single function called
61+
`add_alert()`. This new function is thread-safe and does not require you to acquire a mutex
62+
before calling it like the previous functions did.
6063
- Enhancements
6164
- New `cmd2.Cmd` parameters
6265
- **auto_suggest**: (boolean) if `True`, provide fish shell style auto-suggestions. These

docs/features/prompt.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,11 @@ for an example of dynamically updating the prompt.
2828

2929
## Asynchronous Feedback
3030

31-
`cmd2` provides these functions to provide asynchronous feedback to the user without interfering
32-
with the command line. This means the feedback is provided to the user when they are still entering
33-
text at the prompt. To use this functionality, the application must be running in a terminal that
34-
supports [VT100](https://en.wikipedia.org/wiki/VT100) control characters. Linux, Mac, and Windows 10
35-
and greater all support these.
36-
37-
- [cmd2.Cmd.async_alert][]
38-
- [cmd2.Cmd.async_update_prompt][]
31+
`cmd2` provides a function to deliver asynchronous feedback to the user without interfering with the
32+
command line. This means the feedback is provided to the user when they are still entering text at
33+
the prompt.
34+
35+
- [cmd2.Cmd.add_alert][]
3936

4037
`cmd2` also provides a function to change the title of the terminal window. This feature requires
4138
the application be running in a terminal that supports VT100 control characters. Linux, Mac, and

0 commit comments

Comments
 (0)