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

Mon Aug 13 22:26:52 CEST 2012

http://hg.python.org/cpython/rev/3bddc965e2ea
changeset: 78550:3bddc965e2ea
branch: 2.7
parent: 78536:a4d5ac78a76b
user: Andrew Svetlov <andrew.svetlov at gmail.com>
date: Mon Aug 13 23:26:28 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
@@ -112,9 +112,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
