diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2021-02-19 21:35:13 -0500 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2021-02-19 21:35:13 -0500 |
| commit | 3e180a810e9c4b9d251c135667d1d150b0bbd0dd (patch) | |
| tree | 03e49d5da86d40efa9118eccfd8bd4bbf3dcf86b /docs/api/utils.rst | |
| parent | 4c70bdb03d34c43f833bf77c441452cd402d0715 (diff) | |
| parent | 06aaf962689840631325c70ea7e9056d176c7f67 (diff) | |
| download | cmd2-git-3e180a810e9c4b9d251c135667d1d150b0bbd0dd.tar.gz | |
Merge branch 'master' into black
# Conflicts:
# cmd2/__init__.py
# cmd2/argparse_completer.py
# cmd2/argparse_custom.py
# cmd2/cmd2.py
# cmd2/decorators.py
# cmd2/exceptions.py
# cmd2/utils.py
# examples/arg_decorators.py
# examples/argparse_completion.py
# examples/modular_commands_main.py
# tests/test_argparse_completer.py
# tests/test_argparse_custom.py
# tests/test_cmd2.py
# tests/test_completion.py
# tests/test_history.py
Diffstat (limited to 'docs/api/utils.rst')
| -rw-r--r-- | docs/api/utils.rst | 24 |
1 files changed, 21 insertions, 3 deletions
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 |