diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-11-04 20:09:03 -0500 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-11-04 20:09:03 -0500 |
| commit | ccc236fd32451f923bcf20a4f49c493c89b381d6 (patch) | |
| tree | ba17cec4eda7696cc7d30a9696ff47109bd27bd5 /docs/features/completion.rst | |
| parent | 7440079ab74b58c7809318fa951c1326b466e320 (diff) | |
| download | cmd2-git-ccc236fd32451f923bcf20a4f49c493c89b381d6.tar.gz | |
Fixed documentation in regards to CompletionItem
Diffstat (limited to 'docs/features/completion.rst')
| -rw-r--r-- | docs/features/completion.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/features/completion.rst b/docs/features/completion.rst index dfeddb27..718fb3ba 100644 --- a/docs/features/completion.rst +++ b/docs/features/completion.rst @@ -69,8 +69,9 @@ CompletionItem For Providing Extra Context When tab-completing things like a unique ID from a database, it can often be beneficial to provide the user with some extra context about the item being completed, such as a description. To facilitate this, ``cmd2`` defines the -``CompletionItem`` class which can be used in combination with -``choices_function`` or ``choices_method``. +``CompletionItem`` class which can be returned from any of the 4 completion +functions: ``choices_function``, ``choices_method``, ``completion_function``, +or ``completion_method``. .. autoclass:: cmd2.argparse_custom.CompletionItem :members: |