From c91fd00368aa6d699ce3f3019562664f340543d1 Mon Sep 17 00:00:00 2001 From: kotfu Date: Thu, 20 Feb 2020 22:38:23 -0700 Subject: plugin and hook documentation updates - add api documentation for plugin data classes - update hook and plugin documentation to link to now documented api classes --- cmd2/plugin.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'cmd2/plugin.py') 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() -- cgit v1.2.1