Skip to content

Commit faaf79b

Browse files
committed
Updated with missing doc-string for new CommandSet parameters for cmd2.Cmd's constructor
1 parent 6c939fb commit faaf79b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

cmd2/cmd2.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,14 @@ def __init__(self, completekey: str = 'tab', stdin=None, stdout=None, *,
179179
:param shortcuts: dictionary containing shortcuts for commands. If not supplied,
180180
then defaults to constants.DEFAULT_SHORTCUTS. If you do not want
181181
any shortcuts, pass an empty dictionary.
182+
:param command_sets: Provide CommandSet instances to load during cmd2 initialization.
183+
This allows CommandSets with custom constructor parameters to be
184+
loaded. This also allows the a set of CommandSets to be provided
185+
when `auto_load_commands` is set to False
186+
:param auto_load_commands: If True, cmd2 will check for all subclasses of `CommandSet`
187+
that are currently loaded by Python and automatically
188+
instantiate and register all commands. If False, CommandSets
189+
must be manually installed with `install_command_set`.
182190
"""
183191
# If use_ipython is False, make sure the ipy command isn't available in this instance
184192
if not use_ipython:

0 commit comments

Comments
 (0)