diff options
| -rwxr-xr-x | README.md | 4 | ||||
| -rw-r--r-- | cmd2/cmd2.py | 14 | ||||
| -rw-r--r-- | tests/test_cmd2.py | 5 |
3 files changed, 16 insertions, 7 deletions
@@ -14,8 +14,8 @@ applications. It provides a simple API which is an extension of Python's built- of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary when using cmd. -[](https://github.com/python-cmd2/cmd2/blob/master/cmd2.png) - +Click on image below to watch a short video demonstrating the capabilities of cmd2: +[](https://youtu.be/DDU_JH6cFsA) Main Features ------------- diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index 37033ba4..0dd93662 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -2481,13 +2481,17 @@ Usage: Usage: unalias [-a] name [name ...] doc_block = [] found_first = False for doc_line in doc.splitlines(): - str(doc_line).strip() - if len(doc_line.strip()) > 0: - doc_block.append(doc_line.strip()) - found_first = True - else: + stripped_line = doc_line.strip() + + # Don't include :param type lines + if stripped_line.startswith(':'): if found_first: break + elif stripped_line: + doc_block.append(stripped_line) + found_first = True + elif found_first: + break for doc_line in doc_block: self.stdout.write('{: <{col_width}}{doc}\n'.format(command, diff --git a/tests/test_cmd2.py b/tests/test_cmd2.py index 9cb869bd..6b4dddf6 100644 --- a/tests/test_cmd2.py +++ b/tests/test_cmd2.py @@ -47,6 +47,11 @@ def test_base_help_verbose(base_app): expected = normalize(BASE_HELP_VERBOSE) assert out == expected + # Make sure :param type lines are filtered out of help summary + help_doc = base_app.do_help.__func__.__doc__ + help_doc += "\n:param fake param" + base_app.do_help.__func__.__doc__ = help_doc + out = run_cmd(base_app, 'help --verbose') assert out == expected |