From: jdemeyer <jdemeyer@cage.ugent.be>
Date: Wed, 24 Oct 2018 12:44:41 +0000 (+0200)
Subject: bpo-32797: improve documentation of linecache.getline (GH-9540)
X-Git-Tag: v3.8.0a1~691
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=057f4078b044325dae4af55c4c64b684edaca315;p=thirdparty%2FPython%2Fcpython.git

bpo-32797: improve documentation of linecache.getline (GH-9540)
---

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()