Skip to content

Commit e56d191

Browse files
committed
Move settable documentation from source code to api docs
1 parent c845d33 commit e56d191

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

cmd2/cmd2.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -222,12 +222,6 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
222222
'quiet': "Don't print nonessential feedback",
223223
'timing': 'Report execution times'
224224
}
225-
"""This dictionary contains the name and description of all settings available to users.
226-
227-
Users use the :ref:`features/builtin_commands:set` command to view and
228-
modify settings. Settings are stored in instance attributes with the
229-
same name as the setting.
230-
"""
231225

232226
# Commands to exclude from the help menu and tab completion
233227
self.hidden_commands = ['eof', '_relative_load', '_relative_run_script']

docs/api/cmd.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,11 @@ cmd2.Cmd
1212
.. attribute:: default_error
1313

1414
The error message displayed when a non-existent command is run.
15+
16+
.. attribute:: settable
17+
18+
This dictionary contains the name and description of all settings available to users.
19+
20+
Users use the :ref:`features/builtin_commands:set` command to view and
21+
modify settings. Settings are stored in instance attributes with the
22+
same name as the setting.

0 commit comments

Comments
 (0)