Skip to content

Commit 2bb52e2

Browse files
committed
Updated docstring for cmd2.Cmd.complete_style parameter
1 parent 358ffe5 commit 2bb52e2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

cmd2/cmd2.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -361,8 +361,10 @@ def __init__(
361361
[cmd2.Cmd][] will look for similar commands and suggest them.
362362
:param intro: introduction to display at startup
363363
:param bottom_toolbar: if ``True``, then a bottom toolbar will be displayed.
364-
:param complete_style: style of prompt-toolkit tab completion to use, defaults to CompleteStyle.COLUMN;
365-
set to CompleteStyle.READLINE_LIKE if you want it like readline
364+
:param complete_style: style of prompt-toolkit tab completion to use, 3 valid options are:
365+
1. CompleteStyle.COLUMN (default) - displays hints with help next to them in one big column
366+
2. CompleteStyle.MULTI_COLUMN - displays hints across multiple columns, with help when selected
367+
3. CompleteStyle.READLINE_LIKE - displays like readline, complete_in_thread doesn't work
366368
"""
367369
# Check if py or ipy need to be disabled in this instance
368370
if not include_py:

0 commit comments

Comments
 (0)