summaryrefslogtreecommitdiffstats
path: root/Doc/library/textwrap.rst
diff options
context:
space:
mode:
authorTerry Reedy <tjreedy@udel.edu>2010-11-23 20:17:24 (GMT)
committerTerry Reedy <tjreedy@udel.edu>2010-11-23 20:17:24 (GMT)
commit6d2ab7126eaa10b0b1e8a8bb3cc286604332b6e7 (patch)
treefa5e1f410c15607a7dc27ec262c735d4a3d58833 /Doc/library/textwrap.rst
parent4f13d6145fb01153cee86db9086234178bf30242 (diff)
downloadcpython-6d2ab7126eaa10b0b1e8a8bb3cc286604332b6e7.zip
cpython-6d2ab7126eaa10b0b1e8a8bb3cc286604332b6e7.tar.gz
cpython-6d2ab7126eaa10b0b1e8a8bb3cc286604332b6e7.tar.bz2
Issue 1859: Doc that textwrap does not break on \n (pending possible behavior patch). Patch by Jeremy Thurgood.
Diffstat (limited to 'Doc/library/textwrap.rst')
-rw-r--r--Doc/library/textwrap.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst
index f881701..860f81f 100644
--- a/Doc/library/textwrap.rst
+++ b/Doc/library/textwrap.rst
@@ -121,6 +121,13 @@ indentation from strings that have unwanted whitespace to the left of the text.
each tab character will be replaced by a single space, which is *not*
the same as tab expansion.
+ .. note::
+
+ If :attr:`replace_whitespace` is false, newlines may appear in the
+ middle of a line and cause strange output. For this reason, text should
+ be split into paragraphs (using :meth:`str.splitlines` or similar)
+ which are wrapped separately.
+
.. attribute:: drop_whitespace