From e56d191e4de52482658b267e43eaff5bf324387c Mon Sep 17 00:00:00 2001 From: kotfu Date: Tue, 14 Jan 2020 22:26:08 -0700 Subject: Move settable documentation from source code to api docs --- docs/api/cmd.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/api/cmd.rst') diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst index 5c6b6122..ee8d7c67 100644 --- a/docs/api/cmd.rst +++ b/docs/api/cmd.rst @@ -12,3 +12,11 @@ cmd2.Cmd .. 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. -- cgit v1.2.1