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/overview | |
| 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/overview')
| -rw-r--r-- | docs/overview/integrating.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/overview/integrating.rst b/docs/overview/integrating.rst index e28df1a7..0cc7816e 100644 --- a/docs/overview/integrating.rst +++ b/docs/overview/integrating.rst @@ -1,5 +1,5 @@ Integrate cmd2 Into Your Project -================================ +==================================== Once installed, you will want to ensure that your project's dependencies include ``cmd2``. Make sure your ``setup.py`` includes the following:: @@ -19,7 +19,7 @@ version of ``cmd2``. Windows Considerations -------------------------------- +---------------------- If you would like to use :ref:`features/completion:Completion`, and you want your application to run on Windows, you will need to ensure you install the |