summaryrefslogtreecommitdiff
path: root/cmd2/pyscript_bridge.py
diff options
context:
space:
mode:
Diffstat (limited to 'cmd2/pyscript_bridge.py')
-rw-r--r--cmd2/pyscript_bridge.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/cmd2/pyscript_bridge.py b/cmd2/pyscript_bridge.py
index 944c7eae..e5633173 100644
--- a/cmd2/pyscript_bridge.py
+++ b/cmd2/pyscript_bridge.py
@@ -24,7 +24,7 @@ class CommandResult(namedtuple_with_defaults('CommandResult', ['stdout', 'stderr
----------------------
stdout: str - output captured from stdout while this command is executing
stderr: str - output captured from stderr while this command is executing. None if no error captured.
- stop: bool - return value of the command's corresponding do_* function
+ stop: bool - return value of onecmd_plus_hooks after it runs the given command line.
data - possible data populated by the command.
Any combination of these fields can be used when developing a scripting API for a given command.