diff options
author | kotfu <kotfu@kotfu.net> | 2020-01-14 22:26:08 -0700 |
---|---|---|
committer | kotfu <kotfu@kotfu.net> | 2020-01-14 22:26:08 -0700 |
commit | e56d191e4de52482658b267e43eaff5bf324387c (patch) | |
tree | 7469f0cee66757abbdceb1a8d6a5434877e519c1 | |
parent | c845d33217bdef6c061f4a24864326836f9f1d48 (diff) | |
download | cmd2-git-e56d191e4de52482658b267e43eaff5bf324387c.tar.gz |
Move settable documentation from source code to api docs
-rw-r--r-- | cmd2/cmd2.py | 6 | ||||
-rw-r--r-- | docs/api/cmd.rst | 8 |
2 files changed, 8 insertions, 6 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index 2ae65125..7ad2b471 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -222,12 +222,6 @@ class Cmd(cmd.Cmd): 'quiet': "Don't print nonessential feedback", 'timing': 'Report execution times' } - """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. - """ # Commands to exclude from the help menu and tab completion self.hidden_commands = ['eof', '_relative_load', '_relative_run_script'] 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. |