[issue15288] Clarify the pkgutil.walk_packages() note

[Brett Cannon]

Brett Cannon  added the comment:

Ronan is right that it is all about finders, not importers per-se. I fixed the 
docs to not say "loader".

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue15288] Clarify the pkgutil.walk_packages() note

[Brett Cannon]

Brett Cannon  added the comment:

I changed to term to "loader" and linked to the glossary. I also added a 
versionchanged note for Python 3.3 so people are not too surprised that pkgutil 
no longer does what it did in Python 3.2.

--
resolution:  -> fixed
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue15288] Clarify the pkgutil.walk_packages() note

[Roundup Robot]

Roundup Robot  added the comment:

New changeset 96f7926ea444 by Brett Cannon in branch 'default':
Issue #15288: Clarify that pkgutil.walk_packages() and friends will no
http://hg.python.org/cpython/rev/96f7926ea444

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue15288] Clarify the pkgutil.walk_packages() note

[Ronan Lamy]

Ronan Lamy  added the comment:

It seems that most, if not all, uses of "importer" in pkgutil refer to finders, 
e.g. ImpImporter is a actually only a finder, not an importer. So 
s/importer/finder/ is needed, and perhaps also a note explaining that 
ImpImporter isn't in fact an importer, in addition to glossary links.

--
nosy: +Ronan.Lamy

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue15288] Clarify the pkgutil.walk_packages() note

[Brett Cannon]

Brett Cannon  added the comment:

Probably linking the term "importers" into the glossary should be enough.

--
nosy: +brett.cannon

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue15288] Clarify the pkgutil.walk_packages() note

[Chris Jerdonek]

New submission from Chris Jerdonek :

The note at the end of the pkgutil.walk_packages() (and iter_modules()) 
documentation can be improved somewhat:

http://docs.python.org/dev/library/pkgutil.html#pkgutil.walk_packages

For example, "importers" aren't referenced earlier in the documentation of the 
function, so it's not immediately clear what they are referring to.  I also 
think that enough information should be given so that one can run the examples 
given and have them work.  They currently don't.

I can put together proposed wording.  See the issue 14982 discussion for 
background.

--
assignee: docs@python
components: Documentation
keywords: easy
messages: 164916
nosy: cjerdonek, docs@python
priority: normal
severity: normal
status: open
title: Clarify the pkgutil.walk_packages() note
versions: Python 3.3

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com