summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorTerry Reedy <tjreedy@udel.edu>2010-11-23 20:25:19 (GMT)
committerTerry Reedy <tjreedy@udel.edu>2010-11-23 20:25:19 (GMT)
commit8b7eef3413eb35f3486b4ffa3e7969b86f2678e1 (patch)
tree472fe6291644e9088b5efcad5873c40a3ec717d3 /Doc/library
parent8d4a932e6c5d62658374c31f4e2f6c7a0411a0f1 (diff)
downloadcpython-8b7eef3413eb35f3486b4ffa3e7969b86f2678e1.zip
cpython-8b7eef3413eb35f3486b4ffa3e7969b86f2678e1.tar.gz
cpython-8b7eef3413eb35f3486b4ffa3e7969b86f2678e1.tar.bz2
Issue 1859: Document that textwrap does not break on \n
Merged from 86717
Diffstat (limited to 'Doc/library')
-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 f66416f..8357013 100644
--- a/Doc/library/textwrap.rst
+++ b/Doc/library/textwrap.rst
@@ -117,6 +117,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