[Python-checkins] cpython (merge 3.4 -> 3.5): Issue #20769: Improve reload() docs. Patch by Dorian Pula.

Tue Aug 4 22:32:37 CEST 2015

https://hg.python.org/cpython/rev/9fe1a440e4b8
changeset: 97252:9fe1a440e4b8
branch: 3.5
parent: 97248:e3f381a3423d
parent: 97251:33dfbb293892
user: Robert Collins <rbtcollins at hp.com>
date: Wed Aug 05 08:28:53 2015 +1200
summary:
 Issue #20769: Improve reload() docs. Patch by Dorian Pula.
files:
 Doc/library/importlib.rst | 10 +++++-----
 Misc/ACKS | 1 +
 Misc/NEWS | 2 ++
 3 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
--- a/Doc/library/importlib.rst
+++ b/Doc/library/importlib.rst
@@ -179,11 +179,11 @@
 except NameError:
 cache = {}
 
- It is legal though generally not very useful to reload built-in or
- dynamically loaded modules (this is not true for e.g. :mod:`sys`,
- :mod:`__main__`, :mod:`builtins` and other key modules where reloading is
- frowned upon). In many cases, however, extension modules are not designed to
- be initialized more than once, and may fail in arbitrary ways when reloaded.
+ It is generally not very useful to reload built-in or dynamically loaded
+ modules. Reloading :mod:`sys`, :mod:`__main__`, :mod:`builtins` and other
+ key modules is not recommended. In many cases extension modules are not
+ designed to be initialized more than once, and may fail in arbitrary ways
+ when reloaded.
 
 If a module imports objects from another module using :keyword:`from` ...
 :keyword:`import` ..., calling :func:`reload` for the other module does not
diff --git a/Misc/ACKS b/Misc/ACKS
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -1127,6 +1127,7 @@
 Donovan Preston
 Paul Price
 Iuliia Proskurnia
+Dorian Pula
 Jyrki Pulliainen
 Steve Purcell
 Eduardo Pérez
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -38,6 +38,8 @@
 Documentation
 -------------
 
+- Issue #20769: Improve reload() docs. Patch by Dorian Pula.
+
 - Issue #23589: Remove duplicate sentence from the FAQ. Patch by Yongzhi Pan.
 
 - Issue #24729: Correct IO tutorial to match implementation regarding
-- 
Repository URL: https://hg.python.org/cpython
