Issue 1859: Doc that textwrap does not break on \n (pending possible behavior patch...
authorTerry Reedy <tjreedy@udel.edu>
Tue, 23 Nov 2010 20:17:24 +0000 (20:17 +0000)
committerTerry Reedy <tjreedy@udel.edu>
Tue, 23 Nov 2010 20:17:24 +0000 (20:17 +0000)
Doc/library/textwrap.rst

index f8817013b5faee340d682feae70fc1b065d0c4fe..860f81f9369c91904276c9623c7088a8265d7a1d 100644 (file)
@@ -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