summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTerry Jan Reedy <tjreedy@udel.edu>2017-09-15 17:05:28 (GMT)
committerGitHub <noreply@github.com>2017-09-15 17:05:28 (GMT)
commitff702890027f404dbf5faab6730d1169b3251f66 (patch)
tree85e31ffff95ad56c03c1cedb3aa4c4d7ed2f7b23
parent992f613fe6611f4a3e614a219d0ccb76bc4906d6 (diff)
downloadcpython-ff702890027f404dbf5faab6730d1169b3251f66.zip
cpython-ff702890027f404dbf5faab6730d1169b3251f66.tar.gz
cpython-ff702890027f404dbf5faab6730d1169b3251f66.tar.bz2
bpo-314777: IDLE - improve rstrip entry in doc (#3602)
'Strip trailing whitespace' is not limited to spaces. Wording caters to beginners who do know know the meaning of 'whitespace'. Multiline string literals are not skipped. * News blurb.
-rw-r--r--Doc/library/idle.rst4
-rw-r--r--Lib/idlelib/help.html6
-rw-r--r--Misc/NEWS.d/next/IDLE/2017-09-15-12-38-47.bpo-31477.n__6sa.rst2
3 files changed, 9 insertions, 3 deletions
diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst
index 0faeb6d..af15359 100644
--- a/Doc/library/idle.rst
+++ b/Doc/library/idle.rst
@@ -190,7 +190,9 @@ Format Paragraph
paragraph will be formatted to less than N columns, where N defaults to 72.
Strip trailing whitespace
- Remove any space characters after the last non-space character of a line.
+ Remove trailing space and other whitespace characters after the last
+ non-whitespace character of a line by applying str.rstrip to each line,
+ including lines within multiline strings.
.. index::
single: Run script
diff --git a/Lib/idlelib/help.html b/Lib/idlelib/help.html
index 9005157..33ae884 100644
--- a/Lib/idlelib/help.html
+++ b/Lib/idlelib/help.html
@@ -227,7 +227,9 @@ community is 4 spaces.</dd>
multiline string or selected line in a string. All lines in the
paragraph will be formatted to less than N columns, where N defaults to 72.</dd>
<dt>Strip trailing whitespace</dt>
-<dd>Remove any space characters after the last non-space character of a line.</dd>
+<dd>Remove trailing space and other whitespace characters after the last
+non-whitespace character of a line by applying str.rstrip to each line,
+including lines within multiline strings.</dd>
</dl>
</div>
<div class="section" id="run-menu-editor-window-only">
@@ -779,7 +781,7 @@ also used for testing.</p>
The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>
<br />
- Last updated on Sep 12, 2017.
+ Last updated on Sep 15, 2017.
<a href="../bugs.html">Found a bug</a>?
<br />
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.6.
diff --git a/Misc/NEWS.d/next/IDLE/2017-09-15-12-38-47.bpo-31477.n__6sa.rst b/Misc/NEWS.d/next/IDLE/2017-09-15-12-38-47.bpo-31477.n__6sa.rst
new file mode 100644
index 0000000..4b47ed3
--- /dev/null
+++ b/Misc/NEWS.d/next/IDLE/2017-09-15-12-38-47.bpo-31477.n__6sa.rst
@@ -0,0 +1,2 @@
+IDLE - Improve rstrip entry in doc. Strip trailing whitespace strips more
+than blank spaces. Multiline string literals are not skipped.