summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Svetlov <andrew.svetlov@gmail.com>2012-08-13 20:26:28 (GMT)
committerAndrew Svetlov <andrew.svetlov@gmail.com>2012-08-13 20:26:28 (GMT)
commit33f87a59b8855aa17970c9f680681d24669e7d20 (patch)
tree19c4aed1cee61d89e2948e4b303148981707cd29
parent2f76f73d7326496b7fff114fd478e764c13111f4 (diff)
downloadcpython-33f87a59b8855aa17970c9f680681d24669e7d20.zip
cpython-33f87a59b8855aa17970c9f680681d24669e7d20.tar.gz
cpython-33f87a59b8855aa17970c9f680681d24669e7d20.tar.bz2
Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.
Patch by Chris Jerdonek.
-rw-r--r--Doc/library/textwrap.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst
index 84e6ee1..094e458 100644
--- a/Doc/library/textwrap.rst
+++ b/Doc/library/textwrap.rst
@@ -112,9 +112,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::