summaryrefslogtreecommitdiff
path: root/cmd2.py
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2017-02-12 12:11:49 -0500
committerTodd Leonhardt <todd.leonhardt@gmail.com>2017-02-12 12:11:49 -0500
commit9abc056a1be5ee5e06f6313d61e639e851797502 (patch)
tree3a6ed4e438091cd47b46bcf374dcf08154537722 /cmd2.py
parentf9d241418862d9ee6d680c6f4474363e50bc617f (diff)
downloadcmd2-git-9abc056a1be5ee5e06f6313d61e639e851797502.tar.gz
Fixed doc conf.py so it correctly sets PYTHONPATH for autodoc feature.
Diffstat (limited to 'cmd2.py')
-rwxr-xr-xcmd2.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/cmd2.py b/cmd2.py
index 3a198f8c..b5bb13a9 100755
--- a/cmd2.py
+++ b/cmd2.py
@@ -1455,7 +1455,13 @@ class Cmd(cmd.Cmd):
self.do_load('%s %s' % (targetname, args))
def do_load(self, arg=None):
- """Runs script of command(s) from a file or URL."""
+ """Runs script of command(s) from a file or URL.
+
+ Script should contain one command per line, just like command would be typed in console.
+
+ :param arg: str - Path of file to load and run commands from.
+ :return: bool - True if application should stop (script contained 'quit', typically False to continue running.
+ """
# If arg is None or arg is an empty string, use the default filename
if not arg:
targetname = self.default_file_name