diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/migrating/incompatibilities.rst | 9 | ||||
| -rw-r--r-- | docs/migrating/why.rst | 4 |
2 files changed, 11 insertions, 2 deletions
diff --git a/docs/migrating/incompatibilities.rst b/docs/migrating/incompatibilities.rst index a8a2fcbc..2804aeac 100644 --- a/docs/migrating/incompatibilities.rst +++ b/docs/migrating/incompatibilities.rst @@ -43,6 +43,13 @@ contains A list of queued input lines. The cmdqueue list is checked in processed in order, as if entered at the prompt. Since version 0.9.13 ``cmd2`` has removed support for ``Cmd.cmdqueue``. -Reasoning about application behavior is much easier without this queue present. +Because ``cmd2`` supports running commands via the main ``cmdloop()``, text +scripts, Python scripts, transcripts, and history replays, the only way to +preserve consistent behavior across these methods was to eliminate the command +queue. Additionally, reasoning about application behavior is much easier +without this queue present. + If developers need this sort of thing, they can add it in their application. +However, if they are not extremely careful there would likely be unintended +consequences. diff --git a/docs/migrating/why.rst b/docs/migrating/why.rst index 9c0a0d39..1561bb91 100644 --- a/docs/migrating/why.rst +++ b/docs/migrating/why.rst @@ -22,7 +22,9 @@ cmd2 functionality to make it quicker and easier for developers to create feature-rich interactive command-line applications which delight customers. -``cmd2`` can be used as a drop-in replacement for cmd_. Simply importing +``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 |