diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-09-05 17:24:00 -0400 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-09-05 17:24:00 -0400 |
| commit | 5bc9b967d347356556d30bb04f0a2a9f7662aa06 (patch) | |
| tree | bf309327b8961f9ab27fa290700c62981fa83a37 /docs | |
| parent | f90c8d161437e2f289be2bb578973e3616b844c1 (diff) | |
| download | cmd2-git-5bc9b967d347356556d30bb04f0a2a9f7662aa06.tar.gz | |
Made CustomCompletionSettings public since it's optionally passed to public method cmd2.Cmd.complete().
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/cmd.rst | 27 |
1 files changed, 23 insertions, 4 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst index ced49e3b..3bcc302f 100644 --- a/docs/api/cmd.rst +++ b/docs/api/cmd.rst @@ -1,10 +1,6 @@ cmd2.Cmd ======== -.. autoclass:: cmd2.CompletionMode - :members: - :undoc-members: - .. autoclass:: cmd2.Cmd :members: @@ -69,3 +65,26 @@ cmd2.Cmd The symbol name which :ref:`features/scripting:Python Scripts` run using the :ref:`features/builtin_commands:run_pyscript` command can use to reference the parent ``cmd2`` application. + +.. autoclass:: cmd2.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.cmd2.CustomCompletionSettings + + .. automethod:: __init__
\ No newline at end of file |