summaryrefslogtreecommitdiff
path: root/docs/migrating/why.rst
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2019-07-08 22:03:25 -0400
committerGitHub <noreply@github.com>2019-07-08 22:03:25 -0400
commitdbd83973b62b87e8dc74426af410b0852360f7e8 (patch)
treefab120baf8eaea037cd704da75e2b1dbed09e746 /docs/migrating/why.rst
parent34975b52e769514b44ee8c13147a22961e68e7a7 (diff)
parent8410d4673cefab258c5d3d611365cbb8725a10ab (diff)
downloadcmd2-git-dbd83973b62b87e8dc74426af410b0852360f7e8.tar.gz
Merge pull request #715 from python-cmd2/doc_updates
Started filling in some missing stuff in the new documentation structure
Diffstat (limited to 'docs/migrating/why.rst')
-rw-r--r--docs/migrating/why.rst45
1 files changed, 32 insertions, 13 deletions
diff --git a/docs/migrating/why.rst b/docs/migrating/why.rst
index 71017d89..1561bb91 100644
--- a/docs/migrating/why.rst
+++ b/docs/migrating/why.rst
@@ -3,23 +3,42 @@ Why Migrate to cmd2
.. _cmd: https://docs.python.org/3/library/cmd.html
-``cmd2`` is an extension of cmd_, the Python Standard Library's module for
-creating simple interactive command-line applications.
+cmd
+---
-``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.
+cmd_ is the Python Standard Library's module for creating simple interactive
+command-line applications.
+cmd_ is an extremely bare-bones framework which leaves a lot to be desired. It
+doesn't even include a built-in way to exit from an application!
-Understanding the use of cmd_ is the first step in learning the use of
+Since the API provided by cmd_ provides the foundation on which ``cmd2`` is
+based, 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_.
+cmd2
+----
+``cmd2`` is a batteries-included extension of cmd_, which provides a wealth of
+functionality to make it quicker and easier for developers to create
+feature-rich interactive command-line applications which delight customers.
-Describe why you would want to migrate, and the benefits of doing so
-
-Unicode
-
-features
-
-active community
+``cmd2`` can be used as a drop-in replacement for cmd_ with a few minor
+discrepancies as discussed in the
+:ref:`migrating/incompatibilities:Incompatibilities` section. Simply importing
+``cmd2`` in place of cmd_ will add many features to an application without any
+further modifications. Migrating to ``cmd2`` will also open many additional
+doors for making it possible for developers to provide a top-notch interactive
+command-line experience for their users.
+
+``cmd2`` provides a full-featured framework for creating professional-quality
+interactive command-line applications. A few of the highlights of ``cmd2``
+include:
+
+* Applications created are full-featured shells in their own right with ability
+ to call shell commands, redirect command output, pipe command output to shell
+ commands, etc.
+* Superior tab-completion capabilities, especially when using included argparse
+ decorators
+* Both Python and ASCII text application scripting is built-in
+* Ability to run non-interactively for automation purposes