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

[robert.collins]

https://hg.python.org/cpython/rev/cfd768814ca3
changeset:   97250:cfd768814ca3
branch:      2.7
parent:      97224:0511b1165bb6
user:        Robert Collins <rbtcollins at hp.com>
date:        Wed Aug 05 08:16:41 2015 +1200
summary:
  Issue #20769: Improve reload() docs. Patch by Dorian Pula.

files:
  Doc/library/functions.rst |  9 +++++----
  Misc/ACKS                 |  1 +
  Misc/NEWS                 |  2 ++
  3 files changed, 8 insertions(+), 4 deletions(-)


diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1191,10 +1191,11 @@
       except NameError:
           cache = {}
 
-   It is legal though generally not very useful to reload built-in or dynamically
-   loaded modules, except for :mod:`sys`, :mod:`__main__` and :mod:`__builtin__`.
-   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
@@ -1088,6 +1088,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
@@ -142,6 +142,8 @@
 Documentation
 -------------
 
+- Issue #20769: Improve reload() docs. Patch by Dorian Pula.
+
 - Issue #23589: Remove duplicate sentence from the FAQ.  Patch by Yongzhi Pan.
 
 - Issue #22155: Add File Handlers subsection with createfilehandler to Tkinter

-- 
Repository URL: https://hg.python.org/cpython