diff options
| author | kotfu <kotfu@kotfu.net> | 2020-02-20 21:37:08 -0700 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2020-02-20 21:37:08 -0700 |
| commit | 36465ad953ac550626d219bb08c7ef214eaaede0 (patch) | |
| tree | 438a101d68a6acae872cf72b939ea6015152fad0 /docs/api/cmd.rst | |
| parent | 387d13e75ae7b336b254481012b62361f72824f0 (diff) | |
| download | cmd2-git-36465ad953ac550626d219bb08c7ef214eaaede0.tar.gz | |
Add history api documentation
Diffstat (limited to 'docs/api/cmd.rst')
| -rw-r--r-- | docs/api/cmd.rst | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst index 213a14ec..345e6219 100644 --- a/docs/api/cmd.rst +++ b/docs/api/cmd.rst @@ -29,8 +29,16 @@ cmd2.Cmd .. attribute:: settable - This dictionary contains the name and description of all settings available to users. + 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. + + .. attribute:: history + + A record of previously entered commands. + + This attribute is an instance of :class:`cmd2.history.History`, and + each command is an instance of :class:`cmd2.history.HistoryItem`. |