]> granicus.if.org Git - python/commitdiff
Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.
authorAndrew Svetlov <andrew.svetlov@gmail.com>
Mon, 13 Aug 2012 20:22:23 +0000 (23:22 +0300)
committerAndrew Svetlov <andrew.svetlov@gmail.com>
Mon, 13 Aug 2012 20:22:23 +0000 (23:22 +0300)
Patch by Chris Jerdonek.

Doc/library/textwrap.rst

index a81496206d72c67e40ea1f0aab347678f2595f59..547db79d77c15edfcebdec6bf152144f7187b60f 100644 (file)
@@ -109,9 +109,11 @@ indentation from strings that have unwanted whitespace to the left of the text.
 
    .. attribute:: replace_whitespace
 
-      (default: ``True``) If true, each whitespace character (as defined by
-      ``string.whitespace``) remaining after tab expansion will be replaced by a
-      single space.
+      (default: ``True``) If true, after tab expansion but before wrapping,
+      the :meth:`wrap` method will replace each whitespace character
+      with a single space.  The whitespace characters replaced are
+      as follows: tab, newline, vertical tab, formfeed, and carriage
+      return (``'\t\n\v\f\r'``).
 
       .. note::