summaryrefslogtreecommitdiff
path: root/cmd2/cmd2.py
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2019-03-14 00:04:26 -0400
committerKevin Van Brunt <kmvanbrunt@gmail.com>2019-03-14 00:04:26 -0400
commit42ea15e472ffeb13450cd0d31322a28b581bd392 (patch)
tree3b55af74cd5b18ad2474ce5824a206e2dda83e6d /cmd2/cmd2.py
parent3747fb893bddd7b77373df885d94f25da98ab738 (diff)
downloadcmd2-git-42ea15e472ffeb13450cd0d31322a28b581bd392.tar.gz
Updated documentation
Diffstat (limited to 'cmd2/cmd2.py')
-rw-r--r--cmd2/cmd2.py8
1 files changed, 8 insertions, 0 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
index 6b92a551..6b085a98 100644
--- a/cmd2/cmd2.py
+++ b/cmd2/cmd2.py
@@ -3665,6 +3665,10 @@ class Cmd(cmd.Cmd):
Disable a command and overwrite its functions
:param command: the command being disabled
:param message_to_print: what to print when this command is run or help is called on it while disabled
+
+ The variable COMMAND_NAME can be used as a placeholder for the name of the
+ command being disabled.
+ ex: message_to_print = "{} is currently disabled".format(COMMAND_NAME)
"""
import functools
@@ -3695,6 +3699,10 @@ class Cmd(cmd.Cmd):
:param category: the category to disable
:param message_to_print: what to print when anything in this category is run or help is called on it
while disabled
+
+ The variable COMMAND_NAME can be used as a placeholder for the name of the
+ command being disabled.
+ ex: message_to_print = "{} is currently disabled".format(COMMAND_NAME)
"""
all_commands = self.get_all_commands()