diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-06-16 17:27:30 -0400 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-06-16 17:27:30 -0400 |
| commit | 4869082b495c60309b8b729bdc59e4dd80face74 (patch) | |
| tree | 05e36429db1d66e28351a21b202172c5966c0cef /cmd2/cmd2.py | |
| parent | e3672dfec9c7f0919a726b3e105f06b9474b630f (diff) | |
| download | cmd2-git-4869082b495c60309b8b729bdc59e4dd80face74.tar.gz | |
Improved docstring for ppaged()
Added a couple lines to the ppaged() docstring to help explain the advantages and disadvantages of chopping vs wrapping and when it would be best to do one as opposed to the other.
This should help developers understand the full potential of the ppaged() method.
Diffstat (limited to 'cmd2/cmd2.py')
| -rw-r--r-- | cmd2/cmd2.py | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py index cff73f13..f143d7b3 100644 --- a/cmd2/cmd2.py +++ b/cmd2/cmd2.py @@ -630,7 +630,9 @@ class Cmd(cmd.Cmd): :param end: string appended after the end of the message if not already present, default a newline :param chop: True -> causes lines longer than the screen width to be chopped (truncated) rather than wrapped - truncated text is still accessible by scrolling with the right & left arrow keys + - chopping is ideal for displaying wide tabular data as is done in utilities like pgcli False -> causes lines longer than the screen width to wrap to the next line + - wrapping is ideal when you want to avoid users having to use horizontal scrolling WARNING: On Windows, the text always wraps regardless of what the chop argument is set to """ import subprocess |