diff options
| author | kotfu <kotfu@kotfu.net> | 2020-02-10 16:06:29 -0700 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2020-02-10 16:06:29 -0700 |
| commit | 9c6f1304816707e38c74926c93f62e48836b95c9 (patch) | |
| tree | 07421a95b26ab2f0b76109d0fd3d3d2b52fbeef0 /docs/api | |
| parent | f4c745573e4d777d53e1bcfac743c3b437904034 (diff) | |
| parent | 53a5cef6d56418528e969f55855906f7f602a7b1 (diff) | |
| download | cmd2-git-9c6f1304816707e38c74926c93f62e48836b95c9.tar.gz | |
Merge branch 'api_docs' of https://github.com/python-cmd2/cmd2 into api_docs
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/cmd.rst | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst index e20e8eff..213a14ec 100644 --- a/docs/api/cmd.rst +++ b/docs/api/cmd.rst @@ -6,14 +6,26 @@ cmd2.Cmd .. automethod:: __init__ + .. attribute:: continuation_prompt + + Use as prompt for multiline commands on the 2nd+ line of input. + Default: ``>``. + + .. attribute:: default_error + + The error message displayed when a non-existent command is run. + Default: ``{} is not a recognized command, alias, or macro`` + .. attribute:: help_error The error message displayed to the user when they request help for a command with no help defined. + Default: ``No help on {}`` - .. attribute:: default_error + .. attribute:: prompt - The error message displayed when a non-existent command is run. + The prompt issued to solicit input. + Default: ``(Cmd)``. .. attribute:: settable |