diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-08 16:25:38 -0500 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-08 16:25:38 -0500 |
| commit | a3ff5a516f6188887771c2930c88219b7b0382cf (patch) | |
| tree | ea87ee433abe765dd8562c7492bbbb7cc6e784eb /docs/api/cmd.rst | |
| parent | cf231311e8e4def43c3253e36cfdf41df6a531cd (diff) | |
| download | cmd2-git-a3ff5a516f6188887771c2930c88219b7b0382cf.tar.gz | |
Updated Sphinx documentation related to prompt
Diffstat (limited to 'docs/api/cmd.rst')
| -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 |