summaryrefslogtreecommitdiff
path: root/docs/api/cmd.rst
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2020-02-20 22:38:23 -0700
committerkotfu <kotfu@kotfu.net>2020-02-20 22:38:23 -0700
commitc91fd00368aa6d699ce3f3019562664f340543d1 (patch)
treeeba2b5d5af5d5c91c43657ab5c53b3ae8a201f1d /docs/api/cmd.rst
parent36465ad953ac550626d219bb08c7ef214eaaede0 (diff)
downloadcmd2-git-c91fd00368aa6d699ce3f3019562664f340543d1.tar.gz
plugin and hook documentation updates
- add api documentation for plugin data classes - update hook and plugin documentation to link to now documented api classes
Diffstat (limited to 'docs/api/cmd.rst')
-rw-r--r--docs/api/cmd.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst
index 345e6219..34c0dcf7 100644
--- a/docs/api/cmd.rst
+++ b/docs/api/cmd.rst
@@ -42,3 +42,8 @@ cmd2.Cmd
This attribute is an instance of :class:`cmd2.history.History`, and
each command is an instance of :class:`cmd2.history.HistoryItem`.
+
+ .. attribute:: statement_parser
+
+ An instance of :class:`cmd2.parsing.StatementParser` initialized and
+ configured appropriately for parsing user input.