diff options
| author | kotfu <kotfu@kotfu.net> | 2019-07-06 13:53:45 -0600 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2019-07-06 13:53:45 -0600 |
| commit | 9fe8e36a1e26569bdb47b8c361d077675a876af9 (patch) | |
| tree | 8e72372456ab4f50b61df443fdc1504afb6c1268 /docs/features/prompt.rst | |
| parent | 6a5b9f8e13c9aed75ea23a23bad8ea0c64e90ff7 (diff) | |
| download | cmd2-git-9fe8e36a1e26569bdb47b8c361d077675a876af9.tar.gz | |
Add doc8 documentation style checking
- add dev dependency
- add doc8 to tasks.py
- fix all doc8 errors
Diffstat (limited to 'docs/features/prompt.rst')
| -rw-r--r-- | docs/features/prompt.rst | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/docs/features/prompt.rst b/docs/features/prompt.rst index bda0ec4e..40c50d2b 100644 --- a/docs/features/prompt.rst +++ b/docs/features/prompt.rst @@ -5,30 +5,37 @@ Prompt Asynchronous Feedback --------------------- -``cmd2`` provides two functions to provide asynchronous feedback to the user without interfering with -the command line. This means the feedback is provided to the user when they are still entering text at -the prompt. To use this functionality, the application must be running in a terminal that supports -VT100 control characters and readline. Linux, Mac, and Windows 10 and greater all support these. + +``cmd2`` provides two functions to provide asynchronous feedback to the user +without interfering with the command line. This means the feedback is provided +to the user when they are still entering text at the prompt. To use this +functionality, the application must be running in a terminal that supports +VT100 control characters and readline. Linux, Mac, and Windows 10 and greater +all support these. 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. + 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() - 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. + 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. -``cmd2`` also provides a function to change the title of the terminal window. This feature requires the -application be running in a terminal that supports VT100 control characters. Linux, Mac, and Windows 10 and -greater all support these. +``cmd2`` also provides a function to change the title of the terminal window. +This feature requires the application be running in a terminal that supports +VT100 control characters. Linux, Mac, and Windows 10 and greater all support +these. set_window_title() Sets the terminal window title -The easiest way to understand these functions is to see the AsyncPrinting_ example for a demonstration. +The easiest way to understand these functions is to see the AsyncPrinting_ +example for a demonstration. .. _AsyncPrinting: https://github.com/python-cmd2/cmd2/blob/master/examples/async_printing.py |