summaryrefslogtreecommitdiff
path: root/docs/api/cmd.rst
blob: e20e8effc94503b20edc36e129664894f44e2082 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
cmd2.Cmd
========

.. autoclass:: cmd2.Cmd
    :members:

    .. automethod:: __init__

    .. attribute:: help_error

      The error message displayed to the user when they request help for a
      command with no help defined.

    .. attribute:: default_error

      The error message displayed when a non-existent command is run.

    .. attribute:: settable

        This dictionary contains the name and description of all settings available to users.

        Users use the :ref:`features/builtin_commands:set` command to view and
        modify settings. Settings are stored in instance attributes with the
        same name as the setting.