summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2020-01-28 23:05:44 -0500
committerTodd Leonhardt <todd.leonhardt@gmail.com>2020-01-28 23:05:44 -0500
commite87cadfbaeda0bb0197ce959107bda0db89514ea (patch)
tree9d9b3a13921a6f46e685bb3fcf7235cdb986b761
parent5a88fcf4a54c834edf70bf75020763a23d49f146 (diff)
downloadcmd2-git-e87cadfbaeda0bb0197ce959107bda0db89514ea.tar.gz
Flushed out multiline command documentation
-rw-r--r--docs/features/multiline_commands.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/features/multiline_commands.rst b/docs/features/multiline_commands.rst
index 769e0a64..96063867 100644
--- a/docs/features/multiline_commands.rst
+++ b/docs/features/multiline_commands.rst
@@ -20,3 +20,17 @@ line of input. The prompt for the first line of input is specified by the
``cmd2.Cmd.prompt`` instance attribute - see
:ref:`features/prompt:Customizing the Prompt`. The prompt for subsequent lines
of input is defined by the ``cmd2.Cmd.continuation_prompt`` attribute.
+
+Use cases
+---------
+Multiline commands should probably be used sparingly in order to preserve a
+good user experience for your ``cmd2``-based line-oriented command interpreter
+application.
+
+However, some use cases benefit significantly from the ability to have commands
+that span more than one line. For example, you might want the ability for your
+user to type in a SQL command, which can often span lines and which are
+terminated with a semicolon.
+
+We estimate that less than 5 percent of ``cmd2`` applications use this feature.
+But it is here for those uses cases where it provides value.