[docs] [issue20842] pkgutil docs should reference glossary terms not PEP 302

Martin Panter report at bugs.python.org
Sat Jul 16 05:50:49 EDT 2016


Martin Panter added the comment:

I still think the links are too dense. Three links to the same term in two short paragraphs is too much. Do you think it would be okay to just link the first occurrence for pkgutil.ImpImporter?

Also, there is still a problem at least the definition of “finder” used by the ImpImporter documentation. In PEP 302, “a finder object has a single method: finder.find_module(fullname, path=None)”. This seems to be a pretty good description of the ImpImporter API. However, by dropping the reference to PEP 302, and linking to the glossary definition, we are suggesting that ImpImporter implements importlib.abc.MetaPathFinder and/or importlib.abc.PathEntryFinder. Both these APIs require some sort of find_spec() method, which is not provided by ImpImporter.

As I see it, either Python’s “finder” glossary entry should be adjusted to accommodate PEP 302, or we should retain the PEP 302 reference and not point at the wrong definition of “finder”.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue20842>
_______________________________________


More information about the docs mailing list