diff options
author | kotfu <kotfu@kotfu.net> | 2019-11-29 23:51:12 -0700 |
---|---|---|
committer | kotfu <kotfu@kotfu.net> | 2019-11-29 23:51:12 -0700 |
commit | 52f4275ff0fd1af90b1786c229de2c6fd845ec0e (patch) | |
tree | 5fca419ba6e3484d24fb47db8724e1a12fbf261d /cmd2/cmd2.py | |
parent | 4bc02bb8b33c6d15e1e65ba68608c5b1cc678411 (diff) | |
download | cmd2-git-52f4275ff0fd1af90b1786c229de2c6fd845ec0e.tar.gz |
Finish documenting settings and add new builtin_commands document
Diffstat (limited to 'cmd2/cmd2.py')
-rw-r--r-- | cmd2/cmd2.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index 9174a3f4..c5b058a0 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -225,6 +225,12 @@ 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'] |