diff options
Diffstat (limited to 'docs/migrating')
| -rw-r--r-- | docs/migrating/incompatibilities.rst | 17 | ||||
| -rw-r--r-- | docs/migrating/minimum.rst | 2 | ||||
| -rw-r--r-- | docs/migrating/why.rst | 12 |
3 files changed, 16 insertions, 15 deletions
diff --git a/docs/migrating/incompatibilities.rst b/docs/migrating/incompatibilities.rst index 3d7ddcfb..7a8a5aba 100644 --- a/docs/migrating/incompatibilities.rst +++ b/docs/migrating/incompatibilities.rst @@ -3,8 +3,8 @@ Incompatibilities .. _cmd: https://docs.python.org/3/library/cmd.html -``cmd2`` strives to be drop-in compatible with cmd_, however there are a few things -that are not. +``cmd2`` strives to be drop-in compatible with cmd_, however there are a few +things that are not. cmd.emptyline() @@ -13,9 +13,10 @@ cmd.emptyline() 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_ 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. diff --git a/docs/migrating/minimum.rst b/docs/migrating/minimum.rst index 098ba79c..d604cf7a 100644 --- a/docs/migrating/minimum.rst +++ b/docs/migrating/minimum.rst @@ -1,4 +1,4 @@ Minimum required changes ======================== -The minimum required changes to move to cmd2
\ No newline at end of file +The minimum required changes to move to cmd2 diff --git a/docs/migrating/why.rst b/docs/migrating/why.rst index d1121128..71017d89 100644 --- a/docs/migrating/why.rst +++ b/docs/migrating/why.rst @@ -6,13 +6,13 @@ Why Migrate to cmd2 ``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. +``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_. +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_. Describe why you would want to migrate, and the benefits of doing so |