]> granicus.if.org Git - python/commitdiff
Issue 1859: Document that textwrap does not break on \n
authorTerry Reedy <tjreedy@udel.edu>
Tue, 23 Nov 2010 20:25:19 +0000 (20:25 +0000)
committerTerry Reedy <tjreedy@udel.edu>
Tue, 23 Nov 2010 20:25:19 +0000 (20:25 +0000)
Merged from 86717

Doc/library/textwrap.rst

index f66416f3c62788d4f05845502a384f4b355cea9a..835701340a9c366107b8719c5f53fd70b3cf7508 100644 (file)
@@ -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