classification
Title: Confusing documentation in Lib/importlib/util.py
Type: enhancement Stage:
Components: Documentation Versions: Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: brett.cannon, docs@python, eric.snow, python-dev, vajrasky
Priority: normal Keywords:

Created on 2013-09-07 04:56 by vajrasky, last changed 2013-09-13 20:52 by brett.cannon. This issue is now closed.

Messages (4)
msg197136 - (view) Author: Vajrasky Kok (vajrasky) * Date: 2013-09-07 04:56
In Lib/importlib/util.py, the documentation is confusing me.

Line 42 & 43:

    If an exception is raised and the decorator created the module it is
    subsequently removed from sys.modules.

Is it supposed to be:

    "If an exception is raised and the decorator which created the module is
    subsequently removed from sys.modules." ?
msg197140 - (view) Author: Eric Snow (eric.snow) * (Python committer) Date: 2013-09-07 06:52
It is the module that gets removed.  I suppose it could say, "...created the module, then that module is subsequently...".  Would that help?
msg197146 - (view) Author: Vajrasky Kok (vajrasky) * Date: 2013-09-07 10:46
That would help.
msg197656 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-09-13 20:52
New changeset ecc18ec4a12e by Brett Cannon in branch 'default':
Issue #18955: clarify what is removed by importlib.util.module_for_loader.
http://hg.python.org/cpython/rev/ecc18ec4a12e
History
Date User Action Args
2013-09-13 20:52:53brett.cannonsetstatus: open -> closed
resolution: fixed
2013-09-13 20:52:33python-devsetnosy: + python-dev
messages: + msg197656
2013-09-13 20:13:13ezio.melottisetnosy: + brett.cannon
type: enhancement
2013-09-07 10:46:59vajraskysetmessages: + msg197146
2013-09-07 06:52:45eric.snowsetnosy: + eric.snow
messages: + msg197140
2013-09-07 04:56:33vajraskycreate