From: Terry Reedy <tjreedy@udel.edu>
Date: Tue, 23 Nov 2010 20:28:34 +0000 (+0000)
Subject: Issue 1859: Document that textwrap does not break on \n
X-Git-Tag: v2.7.1~34
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=61ff85e609485c7d9d250c23d30a6ef9bd978576;p=thirdparty%2FPython%2Fcpython.git

Issue 1859: Document that textwrap does not break on \n
Merged from 86717
---

diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst
index bfc63fb4c22c..8fbfe9c1c10f 100644
--- a/Doc/library/textwrap.rst
+++ b/Doc/library/textwrap.rst
@@ -125,6 +125,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