From 61ff85e609485c7d9d250c23d30a6ef9bd978576 Mon Sep 17 00:00:00 2001 From: Terry Reedy Date: Tue, 23 Nov 2010 20:28:34 +0000 Subject: [PATCH] Issue 1859: Document that textwrap does not break on \n Merged from 86717 --- Doc/library/textwrap.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst index bfc63fb4c22..8fbfe9c1c10 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