[Python-checkins] bpo-32797: improve documentation of linecache.getline (GH-9540)
Petr Viktorin
webhook-mailer at python.org
Wed Oct 24 08:44:50 EDT 2018
https://github.com/python/cpython/commit/057f4078b044325dae4af55c4c64b684edaca315
commit: 057f4078b044325dae4af55c4c64b684edaca315
branch: master
author: jdemeyer <jdemeyer at cage.ugent.be>
committer: Petr Viktorin <encukou at gmail.com>
date: 2018-10-24T14:44:41+02:00
summary:
bpo-32797: improve documentation of linecache.getline (GH-9540)
files:
M Doc/library/linecache.rst
diff --git a/Doc/library/linecache.rst b/Doc/library/linecache.rst
index 34fcac57c072..9278fc0641fc 100644
--- a/Doc/library/linecache.rst
+++ b/Doc/library/linecache.rst
@@ -30,10 +30,13 @@ The :mod:`linecache` module defines the following functions:
.. index:: triple: module; search; path
- If a file named *filename* is not found, the function will look for it in the
- module search path, ``sys.path``, after first checking for a :pep:`302`
- ``__loader__`` in *module_globals*, in case the module was imported from a
- zipfile or other non-filesystem import source.
+ If a file named *filename* is not found, the function first checks
+ for a :pep:`302` ``__loader__`` in *module_globals*.
+ If there is such a loader and it defines a ``get_source`` method,
+ then that determines the source lines
+ (if ``get_source()`` returns ``None``, then ``''`` is returned).
+ Finally, if *filename* is a relative filename,
+ it is looked up relative to the entries in the module search path, ``sys.path``.
.. function:: clearcache()
More information about the Python-checkins
mailing list