summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2020-02-05 22:31:18 -0700
committerkotfu <kotfu@kotfu.net>2020-02-05 22:31:18 -0700
commitbf3dc169c047acda1c1cf505e8cd0e9e46d4b4cf (patch)
treee4542578e14c2274dbc7e60271faa163d535007e /docs/api
parent60a212c1c585f0c4c06ffcfeb9882520af8dbf35 (diff)
downloadcmd2-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/api')
-rw-r--r--docs/api/cmd.rst2
-rw-r--r--docs/api/decorators.rst8
-rw-r--r--docs/api/exceptions.rst2
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst
index ee8d7c67..34a34105 100644
--- a/docs/api/cmd.rst
+++ b/docs/api/cmd.rst
@@ -1,7 +1,7 @@
cmd2.Cmd
========
-.. autoclass:: cmd2.cmd2.Cmd
+.. autoclass:: cmd2.Cmd
:members:
.. attribute:: help_error
diff --git a/docs/api/decorators.rst b/docs/api/decorators.rst
index a5fc022e..12ab62fa 100644
--- a/docs/api/decorators.rst
+++ b/docs/api/decorators.rst
@@ -1,10 +1,10 @@
Decorators
==========
-.. autofunction:: cmd2.decorators.with_category
-
-.. autofunction:: cmd2.decorators.with_argument_list
+.. autofunction:: cmd2.decorators.with_argparser
.. autofunction:: cmd2.decorators.with_argparser_and_unknown_args
-.. autofunction:: cmd2.decorators.with_argparser
+.. autofunction:: cmd2.decorators.with_argument_list
+
+.. autofunction:: cmd2.decorators.with_category
diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst
index 656c4a5a..3479fec3 100644
--- a/docs/api/exceptions.rst
+++ b/docs/api/exceptions.rst
@@ -3,4 +3,4 @@ Exceptions
.. autoexception:: cmd2.cmd2.EmbeddedConsoleExit
-.. autoexception:: cmd2.cmd2.EmptyStatement
+.. autoexception:: cmd2.EmptyStatement