summaryrefslogtreecommitdiff
path: root/docs/overview.rst
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2019-07-02 19:02:36 -0600
committerkotfu <kotfu@kotfu.net>2019-07-02 19:02:36 -0600
commit92ae130c38520b249eb7351cfb0da1ad67d3d3cf (patch)
treea403641a1a9412b19e26b52fae83635d812f9409 /docs/overview.rst
parent80950bfa4216ed20df5d63f1ebe63bac5b3746b4 (diff)
downloadcmd2-git-92ae130c38520b249eb7351cfb0da1ad67d3d3cf.tar.gz
Major overhaul of documentation structure for #709
Diffstat (limited to 'docs/overview.rst')
-rw-r--r--docs/overview.rst27
1 files changed, 0 insertions, 27 deletions
diff --git a/docs/overview.rst b/docs/overview.rst
deleted file mode 100644
index 75b8caa9..00000000
--- a/docs/overview.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-
-========
-Overview
-========
-
-``cmd2`` is an extension of cmd_, the Python Standard Library's module for
-creating simple interactive command-line applications.
-
-``cmd2`` can be used as a drop-in replacement for cmd_. Simply importing ``cmd2``
-in place of cmd_ will add many features to an application without any further
-modifications.
-
-Understanding the use of cmd_ is the first step in learning the use of ``cmd2``.
-Once you have read the cmd_ docs, return here to learn the ways that ``cmd2``
-differs from cmd_.
-
-.. note::
-
- ``cmd2`` is not quite a drop-in replacement for cmd_.
- The `cmd.emptyline() <https://docs.python.org/3/library/cmd.html#cmd.Cmd.emptyline>`_ function is called
- when an empty line is entered in response to the prompt. By default, in cmd_ if this method is not overridden, it
- repeats and executes the last nonempty command entered. However, no end user we have encountered views this as
- expected or desirable default behavior. Thus, the default behavior in ``cmd2`` is to simply go to the next line
- and issue the prompt again. At this time, cmd2 completely ignores empty lines and the base class cmd.emptyline()
- method never gets called and thus the emptyline() behavior cannot be overridden.
-
-.. _cmd: https://docs.python.org/3/library/cmd.html