summaryrefslogtreecommitdiff
path: root/cmd2/cmd2.py
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2019-11-17 03:53:13 -0500
committerKevin Van Brunt <kmvanbrunt@gmail.com>2019-11-17 03:53:13 -0500
commitc474c4cb7a910f033cd53764dcf45c68c6b939d2 (patch)
tree66ed54cf0a73ef86c5c861c6c5122bf269fad9dc /cmd2/cmd2.py
parent9a53e36aded1e7dff6d3aaef5770a56917a03309 (diff)
downloadcmd2-git-c474c4cb7a910f033cd53764dcf45c68c6b939d2.tar.gz
Fixed sphinx doc error
Diffstat (limited to 'cmd2/cmd2.py')
-rw-r--r--cmd2/cmd2.py5
1 files changed, 2 insertions, 3 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
index cad91f9d..051e6f7c 100644
--- a/cmd2/cmd2.py
+++ b/cmd2/cmd2.py
@@ -1996,12 +1996,11 @@ class Cmd(cmd.Cmd):
def read_input(self, prompt: str, *, allow_completion: bool = False) -> str:
"""
Read input from appropriate stdin value. Also allows you to disable tab completion while input is being read.
-
:param prompt: prompt to display to user
:param allow_completion: if True, then tab completion of commands is enabled. This generally should be
- set to False unless reading the command line. Defaults to False.
+ set to False unless reading the command line. Defaults to False.
:return: the line read from stdin with all trailing new lines removed
- :raises whatever exceptions are raised by input()
+ :raises any exceptions raised by input() and stdin.readline()
"""
completion_disabled = False
orig_completer = None