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/examples | |
| 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/examples')
| -rw-r--r-- | docs/examples/alternate_event_loops.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/examples/alternate_event_loops.rst b/docs/examples/alternate_event_loops.rst index 317ebd9f..41e27369 100644 --- a/docs/examples/alternate_event_loops.rst +++ b/docs/examples/alternate_event_loops.rst @@ -5,7 +5,7 @@ Throughout this documentation we have focused on the **90%** use case, that is the use case we believe around **90+%** of our user base is looking for. This focuses on ease of use and the best out-of-the-box experience where developers get the most functionality for the least amount of effort. We are talking -about running cmd2 applications with the ``cmdloop()`` method:: +about running ``cmd2`` applications with the ``cmdloop()`` method:: from cmd2 import Cmd class App(Cmd): @@ -78,5 +78,5 @@ with several disadvantages, including: Here is a little more info on ``runcmds_plus_hooks``: -.. automethod:: cmd2.cmd2.Cmd.runcmds_plus_hooks +.. automethod:: cmd2.Cmd.runcmds_plus_hooks :noindex: |