]> granicus.if.org Git - python/commitdiff
bpo-32797: improve documentation of linecache.getline (GH-9540)
authorjdemeyer <jdemeyer@cage.ugent.be>
Wed, 24 Oct 2018 12:44:41 +0000 (14:44 +0200)
committerPetr Viktorin <encukou@gmail.com>
Wed, 24 Oct 2018 12:44:41 +0000 (14:44 +0200)
Doc/library/linecache.rst

index 34fcac57c072d53fce643238d12406e10c6b1ce1..9278fc0641fca841b98bfa03192d6e6a24783dc8 100644 (file)
@@ -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()