summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2018-09-25 00:19:20 -0400
committerKevin Van Brunt <kmvanbrunt@gmail.com>2018-09-25 00:19:20 -0400
commit10dd79e9dee5f0286cd413d513645083e7c44e8a (patch)
tree977f348cfbb7bd3479c8dcd7e473becb798a7bc6 /docs
parent5bce3d00675a46c7b0b8ecb3934c5d7d5d9034af (diff)
downloadcmd2-git-10dd79e9dee5f0286cd413d513645083e7c44e8a.tar.gz
Made async stuff public
Diffstat (limited to 'docs')
-rw-r--r--docs/unfreefeatures.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst
index fd8b0a6d..1b8adb8d 100644
--- a/docs/unfreefeatures.rst
+++ b/docs/unfreefeatures.rst
@@ -198,12 +198,12 @@ the command line. This means the feedback is provided to the user when they are
the prompt. To use this functionality, the application must be running in any terminal that supports
VT100 control characters and readline. Linux, Mac, and Windows 10 and greater all support these.
-_async_alert()
+async_alert()
Used to display an important message to the user while they are at the prompt in between commands.
To the user it appears as if an alert message is printed above the prompt and their current input
text and cursor location is left alone.
-_async_update_prompt()
+async_update_prompt()
Updates the prompt while the user is still typing at it. This is good for alerting the user to system
changes dynamically in between commands. For instance you could alter the color of the prompt to indicate
a system status or increase a counter to report an event.