diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/argparse_completer.rst | 5 | ||||
| -rw-r--r-- | docs/api/argparse_custom.rst | 5 | ||||
| -rw-r--r-- | docs/api/index.rst | 2 | ||||
| -rw-r--r-- | docs/features/argument_processing.rst | 8 | ||||
| -rw-r--r-- | docs/features/completion.rst | 9 |
5 files changed, 18 insertions, 11 deletions
diff --git a/docs/api/argparse_completer.rst b/docs/api/argparse_completer.rst new file mode 100644 index 00000000..0e277582 --- /dev/null +++ b/docs/api/argparse_completer.rst @@ -0,0 +1,5 @@ +cmd2.argparse_completer +======================= + +.. automodule:: cmd2.argparse_completer + :members: diff --git a/docs/api/argparse_custom.rst b/docs/api/argparse_custom.rst new file mode 100644 index 00000000..bdb53e1a --- /dev/null +++ b/docs/api/argparse_custom.rst @@ -0,0 +1,5 @@ +cmd2.argparse_custom +==================== + +.. automodule:: cmd2.argparse_custom + :members: diff --git a/docs/api/index.rst b/docs/api/index.rst index 4009cd29..88229bf1 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -8,6 +8,8 @@ API Reference parsing decorators history + argparse_completer + argparse_custom ansi utils plugin diff --git a/docs/features/argument_processing.rst b/docs/features/argument_processing.rst index 82244d7e..204c2876 100644 --- a/docs/features/argument_processing.rst +++ b/docs/features/argument_processing.rst @@ -342,10 +342,8 @@ Argparse Extensions - ``nargs=(5,)`` - accept 5 or more items - ``nargs=(8, 12)`` - accept 8 to 12 items -``cmd2`` also provides the ``Cmd2ArgumentParser`` class which inherits from -``argparse.ArgumentParser`` and improves error and help output: - -.. autoclass:: cmd2.argparse_custom.Cmd2ArgumentParser - :members: +``cmd2`` also provides the :class:`cmd2.argparse_custom.Cmd2ArgumentParser` +class which inherits from ``argparse.ArgumentParser`` and improves error and +help output. 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. |