Skip to content

Commit 36fdee7

Browse files
committed
Made a few minor clarifying comment tweaks
1 parent 67c7052 commit 36fdee7

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

cmd2.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1181,7 +1181,7 @@ def _help_menu(self):
11811181

11821182
# noinspection PyUnusedLocal
11831183
def do_shortcuts(self, args):
1184-
"""Lists single-key shortcuts available."""
1184+
"""Lists shortcuts (aliases) available."""
11851185
result = "\n".join('%s: %s' % (sc[0], sc[1]) for sc in sorted(self.shortcuts))
11861186
self.stdout.write("Single-key shortcuts for other commands:\n{}\n".format(result))
11871187

@@ -1509,7 +1509,7 @@ def do_py(self, arg):
15091509
py: Enters interactive Python mode.
15101510
End with ``Ctrl-D`` (Unix) / ``Ctrl-Z`` (Windows), ``quit()``, '`exit()``.
15111511
Non-python commands can be issued with ``cmd("your command")``.
1512-
Run python code from external files with ``run("filename.py")``
1512+
Run python code from external script files with ``run("filename.py")``
15131513
"""
15141514
if self._in_py:
15151515
self.perror("Recursively entering interactive Python consoles is not allowed.", traceback_war=False)
@@ -1802,7 +1802,7 @@ def _read_file_or_url(self, fname):
18021802
def do__relative_load(self, arg=None):
18031803
"""Runs commands in script at file or URL.
18041804
1805-
Usage: load [file_path]
1805+
Usage: _relative_load [file_path]
18061806
18071807
optional argument:
18081808
file_path a file path or URL pointing to a script
@@ -1812,6 +1812,8 @@ def do__relative_load(self, arg=None):
18121812
18131813
If this is called from within an already-running script, the filename will be interpreted
18141814
relative to the already-running script's directory.
1815+
1816+
NOTE: This command is intended to only be used within text file scripts.
18151817
"""
18161818
if arg:
18171819
arg = arg.split(None, 1)

0 commit comments

Comments
 (0)