summaryrefslogtreecommitdiff
path: root/tests/test_cmd2.py
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2018-09-24 19:48:22 -0400
committerGitHub <noreply@github.com>2018-09-24 19:48:22 -0400
commit0269c6c4b3aed822aadef08f4c28865db58055ca (patch)
tree1a88e7661100193c4b063e3ac6f48b97cb2cbe64 /tests/test_cmd2.py
parente5e8a7954b9ace78cd49ef43c5f8d6203c227f0f (diff)
parent850b234a352d5140c5959ed9245b355e6837b529 (diff)
downloadcmd2-git-0269c6c4b3aed822aadef08f4c28865db58055ca.tar.gz
Merge pull request #536 from python-cmd2/help_summary
Prevent :param and :return type lines from showing in help summaries
Diffstat (limited to 'tests/test_cmd2.py')
-rw-r--r--tests/test_cmd2.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/tests/test_cmd2.py b/tests/test_cmd2.py
index 4b0687c9..7a8a52a0 100644
--- a/tests/test_cmd2.py
+++ b/tests/test_cmd2.py
@@ -46,6 +46,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