summaryrefslogtreecommitdiff
path: root/docs/migrating/incompatibilities.rst
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2019-07-06 13:53:45 -0600
committerkotfu <kotfu@kotfu.net>2019-07-06 13:53:45 -0600
commit9fe8e36a1e26569bdb47b8c361d077675a876af9 (patch)
tree8e72372456ab4f50b61df443fdc1504afb6c1268 /docs/migrating/incompatibilities.rst
parent6a5b9f8e13c9aed75ea23a23bad8ea0c64e90ff7 (diff)
downloadcmd2-git-9fe8e36a1e26569bdb47b8c361d077675a876af9.tar.gz
Add doc8 documentation style checking
- add dev dependency - add doc8 to tasks.py - fix all doc8 errors
Diffstat (limited to 'docs/migrating/incompatibilities.rst')
-rw-r--r--docs/migrating/incompatibilities.rst17
1 files changed, 9 insertions, 8 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.