diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-01-16 11:12:35 -0500 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-01-16 11:12:35 -0500 |
| commit | 64c05ab4fd71f2c235644af2d18672edf6757702 (patch) | |
| tree | 88777e27696ec208c193c13838a6c0d3dcc95f5f /docs | |
| parent | 6ef3b08257c768b353d3cfa726e3f19c34f0cf53 (diff) | |
| download | cmd2-git-64c05ab4fd71f2c235644af2d18672edf6757702.tar.gz | |
Updating some doc text
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/features/settings.rst | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/features/settings.rst b/docs/features/settings.rst index a8c0705f..627f61a9 100644 --- a/docs/features/settings.rst +++ b/docs/features/settings.rst @@ -70,7 +70,8 @@ echo ~~~~ If ``True``, each command the user issues will be repeated to the screen before -it is executed. This is particularly useful when running scripts. +it is executed. This is particularly useful when running scripts. This behavior +does not occur when a running command at the prompt. editor @@ -104,7 +105,13 @@ Allow access to your application in one of the max_completion_items ~~~~~~~~~~~~~~~~~~~~ -The maximum number of tab-completion items to display. +Maximum number of CompletionItems to display during tab completion. A CompletionItem +is a special kind of tab-completion hint which displays both a value and description +and uses one line for each hint. Tab complete the ``set`` command for an example. + +If the number of tab-completion hints exceeds ``max_completion_items``, then they will +be displayed in the typical columnized format and will not include the description text +of the CompletionItem. prompt |