diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/exceptions.rst | 3 | ||||
| -rw-r--r-- | docs/api/utils.rst | 24 |
2 files changed, 24 insertions, 3 deletions
diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst index db23eb0a..98afa97a 100644 --- a/docs/api/exceptions.rst +++ b/docs/api/exceptions.rst @@ -12,3 +12,6 @@ Custom cmd2 exceptions .. autoclass:: cmd2.exceptions.CommandSetRegistrationError :members: + +.. autoclass:: cmd2.exceptions.CompletionError + :members: diff --git a/docs/api/utils.rst b/docs/api/utils.rst index 0013bb7a..81c978c9 100644 --- a/docs/api/utils.rst +++ b/docs/api/utils.rst @@ -43,10 +43,28 @@ IO Handling Tab Completion -------------- -.. autoclass:: cmd2.utils.CompletionError - :members: +.. 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. -.. autofunction:: cmd2.utils.basic_complete + .. 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 |