diff options
author | kotfu <kotfu@kotfu.net> | 2019-11-29 22:29:47 -0700 |
---|---|---|
committer | kotfu <kotfu@kotfu.net> | 2019-11-29 22:29:47 -0700 |
commit | 309f542d5de2d357a64bcbf0a8bdb1d90918fb0f (patch) | |
tree | 2645919f16493c8f67fa1a9106086446ebd16896 /docs | |
parent | 69b108a8865ba96fd5959a3f1a8237c5e8f18732 (diff) | |
download | cmd2-git-309f542d5de2d357a64bcbf0a8bdb1d90918fb0f.tar.gz |
Minor formatting cleanups
Diffstat (limited to 'docs')
-rw-r--r-- | docs/migrating/incompatibilities.rst | 15 | ||||
-rw-r--r-- | docs/migrating/next_steps.rst | 9 |
2 files changed, 12 insertions, 12 deletions
diff --git a/docs/migrating/incompatibilities.rst b/docs/migrating/incompatibilities.rst index 7526b51b..ba6f2ed1 100644 --- a/docs/migrating/incompatibilities.rst +++ b/docs/migrating/incompatibilities.rst @@ -46,15 +46,16 @@ writing a :ref:`Postparsing Hook <features/hooks:Postparsing Hooks>`. Cmd.cmdqueue ------------ + In cmd_, the `Cmd.cmdqueue <https://docs.python.org/3/library/cmd.html#cmd.Cmd.cmdqueue>`_ attribute -contains A list of queued input lines. The cmdqueue list is checked in +contains a list of queued input lines. The cmdqueue list is checked in ``cmdloop()`` when new input is needed; if it is nonempty, its elements will be processed in order, as if entered at the prompt. -Since version 0.9.13 ``cmd2`` has removed support for ``Cmd.cmdqueue``. -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. +Since version 0.9.13 ``cmd2`` has removed support for ``Cmd.cmdqueue``. 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. diff --git a/docs/migrating/next_steps.rst b/docs/migrating/next_steps.rst index f43c69c9..d95473ee 100644 --- a/docs/migrating/next_steps.rst +++ b/docs/migrating/next_steps.rst @@ -15,9 +15,8 @@ For all but the simplest of commands, it's probably easier to use `argparse ``cmd2`` provides a ``@with_argparser()`` decorator which associates an ``ArgumentParser`` object with one of your commands. Using this method will: -1. Pass your command a `Namespace -<https://docs.python.org/3/library/argparse.html#argparse.Namespace>`_ -containing the arguments instead of a string of text. +1. Pass your command a `Namespace <https://docs.python.org/3/library/argparse.html#argparse.Namespace>`_ + containing the arguments instead of a string of text. 2. Properly handle quoted string input from your users. @@ -52,8 +51,8 @@ Generating Output ----------------- If your program generates output by printing directly to ``sys.stdout``, you -should consider switching to :meth:`cmd2.cmd2.Cmd.poutput`, -:meth:`cmd2.cmd2.Cmd.perror`, and :meth:`cmd2.cmd2.Cmd.pfeedback`. These +should consider switching to :meth:`~cmd2.cmd2.Cmd.poutput`, +:meth:`~cmd2.cmd2.Cmd.perror`, and :meth:`~cmd2.cmd2.Cmd.pfeedback`. These methods work with several of the built in :ref:`features/settings:Settings` to allow the user to view or suppress feedback (i.e. progress or status output). They also properly handle ansi colored output according to user preference. |