summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2018-07-09 23:22:51 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2018-07-09 23:22:51 -0400
commit7e2d0ea77d44e5fc009b3593b80ddbc1bf01b014 (patch)
tree89d2ae30f2b39a5de28b8e09725bac2bba116d2b
parent766f8f7b02f771d7cd4ca812c1f0ebfe76e5faf8 (diff)
downloadcmd2-git-7e2d0ea77d44e5fc009b3593b80ddbc1bf01b014.tar.gz
Fixed a Sphinx autodoc warning due to minor formatting issues in docstring of ppaged method
-rw-r--r--cmd2/cmd2.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
index 8bdcf083..356600c7 100644
--- a/cmd2/cmd2.py
+++ b/cmd2/cmd2.py
@@ -584,12 +584,13 @@ class Cmd(cmd.Cmd):
:param msg: message to print to current stdout - anything convertible to a str with '{}'.format() is OK
: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
+ :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
+
+ WARNING: On Windows, the text always wraps regardless of what the chop argument is set to
"""
import subprocess
if msg is not None and msg != '':