diff options
Diffstat (limited to 'docs/features/completion.rst')
| -rw-r--r-- | docs/features/completion.rst | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/docs/features/completion.rst b/docs/features/completion.rst index b7e9ba5e..083178dc 100644 --- a/docs/features/completion.rst +++ b/docs/features/completion.rst @@ -69,12 +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 returned from any of the 4 completion -functions: ``choices_function``, ``choices_method``, ``completion_function``, -or ``completion_method``. - -.. autoclass:: cmd2.argparse_custom.CompletionItem - :members: +:class:`cmd2.argparse_custom.CompletionItem` class which can be returned from +any of the 4 completion functions: ``choices_function``, ``choices_method``, +``completion_function``, or ``completion_method``. See the argparse_completion_ example or the implementation of the built-in **set** command for demonstration of how this is used. |