summaryrefslogtreecommitdiff
path: root/cmd2
diff options
context:
space:
mode:
authorEric Lin <anselor@gmail.com>2020-08-10 12:27:48 -0400
committeranselor <anselor@gmail.com>2020-08-10 23:00:09 -0400
commitfaaf79b695a4ee91634d166dd050d2a28bb65632 (patch)
tree4679143df472a8c2f6d4f9e24bf7a0b75915058d /cmd2
parent6c939fb0fffd076b4471591fda79f85db2aab460 (diff)
downloadcmd2-git-faaf79b695a4ee91634d166dd050d2a28bb65632.tar.gz
Updated with missing doc-string for new CommandSet parameters for cmd2.Cmd's constructor
Diffstat (limited to 'cmd2')
-rw-r--r--cmd2/cmd2.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
index 39feac68..621228db 100644
--- a/cmd2/cmd2.py
+++ b/cmd2/cmd2.py
@@ -179,6 +179,14 @@ class Cmd(cmd.Cmd):
:param shortcuts: dictionary containing shortcuts for commands. If not supplied,
then defaults to constants.DEFAULT_SHORTCUTS. If you do not want
any shortcuts, pass an empty dictionary.
+ :param command_sets: Provide CommandSet instances to load during cmd2 initialization.
+ This allows CommandSets with custom constructor parameters to be
+ loaded. This also allows the a set of CommandSets to be provided
+ when `auto_load_commands` is set to False
+ :param auto_load_commands: If True, cmd2 will check for all subclasses of `CommandSet`
+ that are currently loaded by Python and automatically
+ instantiate and register all commands. If False, CommandSets
+ must be manually installed with `install_command_set`.
"""
# If use_ipython is False, make sure the ipy command isn't available in this instance
if not use_ipython: