summaryrefslogtreecommitdiff
path: root/cmd2/plugin.py
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 /cmd2/plugin.py
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 'cmd2/plugin.py')
-rw-r--r--cmd2/plugin.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/cmd2/plugin.py b/cmd2/plugin.py
index dc9ec297..83093ee1 100644
--- a/cmd2/plugin.py
+++ b/cmd2/plugin.py
@@ -6,22 +6,26 @@ import attr
@attr.s
class PostparsingData:
+ """Data class containing information passed to postparsing hook methods"""
stop = attr.ib()
statement = attr.ib()
@attr.s
class PrecommandData:
+ """Data class containing information passed to precommand hook methods"""
statement = attr.ib()
@attr.s
class PostcommandData:
+ """Data class containing information passed to postcommand hook methods"""
stop = attr.ib()
statement = attr.ib()
@attr.s
class CommandFinalizationData:
+ """Data class containing information passed to command finalization hook methods"""
stop = attr.ib()
statement = attr.ib()