diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2020-02-06 23:30:33 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-06 23:30:33 -0500 |
| commit | 3c627af7c1e22bcd0cd0a49dee05fd6b626bccc5 (patch) | |
| tree | ba04d09ce9d0df114890db8e31dd6cb6988f9d7b /docs/api | |
| parent | c7ac2e965d025806ce5baddfc718814e3e58d639 (diff) | |
| parent | 90152df53478a00a3c64ba5ece160485408680dd (diff) | |
| download | cmd2-git-3c627af7c1e22bcd0cd0a49dee05fd6b626bccc5.tar.gz | |
Merge pull request #875 from python-cmd2/doc_streamline
Doc streamline
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/cmd.rst | 4 | ||||
| -rw-r--r-- | docs/api/decorators.rst | 8 | ||||
| -rw-r--r-- | docs/api/exceptions.rst | 4 |
3 files changed, 8 insertions, 8 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst index ee8d7c67..e20e8eff 100644 --- a/docs/api/cmd.rst +++ b/docs/api/cmd.rst @@ -1,9 +1,11 @@ cmd2.Cmd ======== -.. autoclass:: cmd2.cmd2.Cmd +.. autoclass:: cmd2.Cmd :members: + .. automethod:: __init__ + .. attribute:: help_error The error message displayed to the user when they request help for a 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..400993aa 100644 --- a/docs/api/exceptions.rst +++ b/docs/api/exceptions.rst @@ -1,6 +1,4 @@ Exceptions ========== -.. autoexception:: cmd2.cmd2.EmbeddedConsoleExit - -.. autoexception:: cmd2.cmd2.EmptyStatement +.. autoexception:: cmd2.EmptyStatement |