[Python-checkins] bpo-35088: Update idlelib.help.copy_string docstring (GH-10164)
Miss Islington (bot)
webhook-mailer at python.org
Sun Oct 28 02:01:28 EDT 2018
https://github.com/python/cpython/commit/0e6329db493d4bef6aa35ae613c3c6a8453066a5
commit: 0e6329db493d4bef6aa35ae613c3c6a8453066a5
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-10-27T23:01:25-07:00
summary:
bpo-35088: Update idlelib.help.copy_string docstring (GH-10164)
We now use git and backporting instead of hg and forward merging.
(cherry picked from commit 2b555fc1f07bee8b066a6d7da727e516f37e8e34)
Co-authored-by: Terry Jan Reedy <tjreedy at udel.edu>
files:
A Misc/NEWS.d/next/IDLE/2018-10-28-00-54-32.bpo-35088.r1lJZd.rst
M Lib/idlelib/help.py
diff --git a/Lib/idlelib/help.py b/Lib/idlelib/help.py
index ae991ee8baec..0603ede822ba 100644
--- a/Lib/idlelib/help.py
+++ b/Lib/idlelib/help.py
@@ -240,28 +240,28 @@ def __init__(self, parent, filename, title):
def copy_strip():
"""Copy idle.html to idlelib/help.html, stripping trailing whitespace.
- Files with trailing whitespace cannot be pushed to the hg cpython
+ Files with trailing whitespace cannot be pushed to the git cpython
repository. For 3.x (on Windows), help.html is generated, after
- editing idle.rst in the earliest maintenance version, with
+ editing idle.rst on the master branch, with
sphinx-build -bhtml . build/html
python_d.exe -c "from idlelib.help import copy_strip; copy_strip()"
- After refreshing TortoiseHG workshop to generate a diff,
- check both the diff and displayed text. Push the diff along with
- the idle.rst change and merge both into default (or an intermediate
- maintenance version).
-
- When the 'earlist' version gets its final maintenance release,
- do an update as described above, without editing idle.rst, to
- rebase help.html on the next version of idle.rst. Do not worry
- about version changes as version is not displayed. Examine other
- changes and the result of Help -> IDLE Help.
-
- If maintenance and default versions of idle.rst diverge, and
- merging does not go smoothly, then consider generating
- separate help.html files from separate idle.htmls.
+ Check build/html/library/idle.html, the help.html diff, and the text
+ displayed by Help => IDLE Help. Add a blurb and create a PR.
+
+ It can be worthwhile to occasionally generate help.html without
+ touching idle.rst. Changes to the master version and to the doc
+ build system may result in changes that should not changed
+ the displayed text, but might break HelpParser.
+
+ As long as master and maintenance versions of idle.rst remain the
+ same, help.html can be backported. The internal Python version
+ number is not displayed. If maintenance idle.rst diverges from
+ the master version, then instead of backporting help.html from
+ master, repeat the proceedure above to generate a maintenance
+ version.
"""
src = join(abspath(dirname(dirname(dirname(__file__)))),
- 'Doc', 'build', 'html', 'library', 'idle.html')
+ 'Doc', 'build', 'html', 'library', 'idle.html')
dst = join(abspath(dirname(__file__)), 'help.html')
with open(src, 'rb') as inn,\
open(dst, 'wb') as out:
diff --git a/Misc/NEWS.d/next/IDLE/2018-10-28-00-54-32.bpo-35088.r1lJZd.rst b/Misc/NEWS.d/next/IDLE/2018-10-28-00-54-32.bpo-35088.r1lJZd.rst
new file mode 100644
index 000000000000..993ff51d74e5
--- /dev/null
+++ b/Misc/NEWS.d/next/IDLE/2018-10-28-00-54-32.bpo-35088.r1lJZd.rst
@@ -0,0 +1,2 @@
+Update idlelib.help.copy_string docstring. We now use git and backporting
+instead of hg and forward merging.
More information about the Python-checkins
mailing list