diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-09-09 03:06:21 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-09 03:06:21 -0400 |
| commit | c50def1eff00f7f44adcb911d215ace65d16aa8a (patch) | |
| tree | 62575c664a651027cea415cea574454d1e4637ca /docs/api/utils.rst | |
| parent | a975432ea87b8bde7d879f6e0974dcaffedc5f78 (diff) | |
| parent | 1a2095e5c373430e5aa4bda2ee24f65f4527a002 (diff) | |
| download | cmd2-git-c50def1eff00f7f44adcb911d215ace65d16aa8a.tar.gz | |
Merge pull request #991 from python-cmd2/read_input
Read input enhancements
Diffstat (limited to 'docs/api/utils.rst')
| -rw-r--r-- | docs/api/utils.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/api/utils.rst b/docs/api/utils.rst index 188f5b16..9276587f 100644 --- a/docs/api/utils.rst +++ b/docs/api/utils.rst @@ -36,6 +36,33 @@ IO Handling :members: +Tab Completion +-------------- + +.. autoclass:: cmd2.utils.CompletionMode + + .. attribute:: NONE + + Tab completion will be disabled during read_input() call. Use of custom + up-arrow history supported. + + .. attribute:: COMMANDS + + read_input() will tab complete cmd2 commands and their arguments. + cmd2's command line history will be used for up arrow if history is not + provided. Otherwise use of custom up-arrow history supported. + + .. attribute:: CUSTOM + + read_input() will tab complete based on one of its following parameters + (choices, choices_provider, completer, parser). Use of custom up-arrow + history supported + +.. autoclass:: cmd2.utils.CustomCompletionSettings + + .. automethod:: __init__ + + Text Alignment -------------- |