Issue python#20769: Improve reload() docs. Patch by Dorian Pula.

aib · Aug 4, 2015 · b3ca31f · b3ca31f
2 parents 78c89eb + 1ae28d2
commit b3ca31f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
@@ -179,11 +179,11 @@ Functions
       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
@@ -1127,6 +1127,7 @@ Paul Prescod
 Donovan Preston
 Paul Price
 Iuliia Proskurnia
+Dorian Pula
 Jyrki Pulliainen
 Steve Purcell
 Eduardo Pérez

diff --git a/Misc/NEWS b/Misc/NEWS
@@ -38,6 +38,8 @@ Library
 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