diff options
| author | kotfu <kotfu@kotfu.net> | 2020-02-05 22:31:18 -0700 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2020-02-05 22:31:18 -0700 |
| commit | bf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf (patch) | |
| tree | e4542578e14c2274dbc7e60271faa163d535007e /docs/migrating/next_steps.rst | |
| parent | 60a212c1c585f0c4c06ffcfeb9882520af8dbf35 (diff) | |
| download | cmd2-git-bf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf.tar.gz | |
Clean up class and method references
- In docs/api/cmd.rst, the `cmd2.Cmd` class was defined as `cmd2.cmd2.Cmd`, which required the extraneous `cmd2` every time we referenced it. This extra `cmd2` is no longer required.
- always refer to a bare cmd2 using ``cmd2`` per our documentation conventions
Diffstat (limited to 'docs/migrating/next_steps.rst')
| -rw-r--r-- | docs/migrating/next_steps.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/migrating/next_steps.rst b/docs/migrating/next_steps.rst index d95473ee..545e1c0a 100644 --- a/docs/migrating/next_steps.rst +++ b/docs/migrating/next_steps.rst @@ -51,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.Cmd.poutput`, +:meth:`~cmd2.Cmd.perror`, and :meth:`~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. |