diff options
| author | Eric Lin <anselor@gmail.com> | 2018-04-10 14:53:53 -0400 |
|---|---|---|
| committer | Eric Lin <anselor@gmail.com> | 2018-04-10 14:53:53 -0400 |
| commit | f4f2b9ede5f34459d84dee21400cc23bc6008776 (patch) | |
| tree | 067e35e2f298bab0929e1ce0496be3d610dba67b /examples | |
| parent | da285649ecda95f273bf1bf498b0e89c14e217b4 (diff) | |
| download | cmd2-git-f4f2b9ede5f34459d84dee21400cc23bc6008776.tar.gz | |
Added verbose help output with help -v or help --verbose
Reads the __doc__ for a command function and provides the first block of text for each command.
Updated help_categories.py to demonstrate a multi-line comment block for a command.
Diffstat (limited to 'examples')
| -rwxr-xr-x | examples/help_categories.py | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/examples/help_categories.py b/examples/help_categories.py index 6583d795..2a88edba 100755 --- a/examples/help_categories.py +++ b/examples/help_categories.py @@ -100,7 +100,14 @@ class HelpCategories(Cmd): self.poutput('Thread Dump') def do_sslconnectorciphers(self, _): - """SSL Connector Ciphers command""" + """ + SSL Connector Ciphers command is an example of a command that contains + multiple lines of help information for the user. Each line of help in a + contiguous set of lines will be printed and aligned in the verbose output + provided with 'help --verbose' + + This is after a blank line and won't de displayed in the verbose help + """ self.poutput('SSL Connector Ciphers') def do_vminfo(self, _): |
