diff options
| author | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-08-13 20:22:23 (GMT) |
|---|---|---|
| committer | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-08-13 20:22:23 (GMT) |
| commit | 59db40166760e270aab5417b5933022349cd35ee (patch) | |
| tree | 33ffaba170fc556cdc396cfc391fdce08b2a589f /Doc/library/textwrap.rst | |
| parent | 50be452e0fcc33195ce7d93bb808ca4be9654bd6 (diff) | |
| download | cpython-59db40166760e270aab5417b5933022349cd35ee.zip cpython-59db40166760e270aab5417b5933022349cd35ee.tar.gz cpython-59db40166760e270aab5417b5933022349cd35ee.tar.bz2 | |
Issue #15497: Correct characters in TextWrapper.replace_whitespace docs.
Patch by Chris Jerdonek.
Diffstat (limited to 'Doc/library/textwrap.rst')
| -rw-r--r-- | Doc/library/textwrap.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst index a814962..547db79 100644 --- a/Doc/library/textwrap.rst +++ b/Doc/library/textwrap.rst @@ -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:: |