summaryrefslogtreecommitdiff
path: root/docs/examples
diff options
context:
space:
mode:
Diffstat (limited to 'docs/examples')
-rw-r--r--docs/examples/index.rst2
-rw-r--r--docs/examples/remove_builtin_commands.rst41
-rw-r--r--docs/examples/removing_builtin_commands.rst7
3 files changed, 42 insertions, 8 deletions
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
index 65cb475f..f895059f 100644
--- a/docs/examples/index.rst
+++ b/docs/examples/index.rst
@@ -5,5 +5,5 @@ Examples
:maxdepth: 1
first_app
- removing_builtin_commands
+ remove_builtin_commands
alternate_event_loops
diff --git a/docs/examples/remove_builtin_commands.rst b/docs/examples/remove_builtin_commands.rst
new file mode 100644
index 00000000..c3e73b0c
--- /dev/null
+++ b/docs/examples/remove_builtin_commands.rst
@@ -0,0 +1,41 @@
+Remove Built-in Commands
+=========================
+
+``cmd2`` comes with a bunch of built-in commands. These commands add lots of
+useful functionality, but you might not want them in your application. You can
+either hide these commands, or remove them completely.
+
+
+Hiding Commands
+---------------
+
+When a command is hidden, it is still available to run, but it won't show in
+the help menu. To hide a command::
+
+ class HideBuiltinCommand(cmd2.Cmd):
+ """Hide a built-in command."""
+
+ def __init__(self):
+ super().__init__()
+
+ # To prevent commands from displaying in the help menu
+ # add them to the hidden_commands list
+ self.hidden_commands.append('py')
+
+
+Removing Commands
+-----------------
+
+You can remove a command from your application is defined in ``cmd2.Cmd`` or
+inherited from a :ref:`plugin <features/plugins:Plugins>`. Delete the
+command method in your initialization code::
+
+ class RemoveBuiltinCommand(cmd2.Cmd):
+ """Remove an undesired built-in command."""
+
+ def __init__(self):
+ super().__init__()
+
+ # To remove built-in commands entirely, delete
+ # the "do_*" function from the cmd2.Cmd class
+ del cmd2.Cmd.do_edit
diff --git a/docs/examples/removing_builtin_commands.rst b/docs/examples/removing_builtin_commands.rst
deleted file mode 100644
index 63f5160a..00000000
--- a/docs/examples/removing_builtin_commands.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-Removing Builtin Commands
-=========================
-
-Show how to remove built in comamnds. Say for example you don't like the
-``quit`` command included in ``cmd2``. Your application has to subclass
-``cmd2.Cmd`` to work, which means you inherit the ``quit`` command. Here's how
-to remove it.