[Python-checkins] cpython (3.2): Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.

[andrew.svetlov]

http://hg.python.org/cpython/rev/90a8a462d2f7
changeset:   78548:90a8a462d2f7
branch:      3.2
parent:      78545:381aaf79c254
user:        Andrew Svetlov <andrew.svetlov at gmail.com>
date:        Mon Aug 13 23:22:23 2012 +0300
summary:
  Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.

Patch by Chris Jerdonek.

files:
  Doc/library/textwrap.rst |  8 +++++---
  1 files changed, 5 insertions(+), 3 deletions(-)


diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst
--- a/Doc/library/textwrap.rst
+++ b/Doc/library/textwrap.rst
@@ -109,9 +109,11 @@
 
    .. 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::
 

-- 
Repository URL: http://hg.python.org/cpython