diff options
| author | R David Murray <rdmurray@bitdance.com> | 2015-03-20 11:31:38 -0400 |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2015-03-20 11:31:38 -0400 |
| commit | b667e288fc31d73385d46058874421a96e032153 (patch) | |
| tree | f7f295cf6a974814e810757236943d150eba28e3 /Doc/library/linecache.rst | |
| parent | c7e61c70f8466b6a8f6b35a6c1254f220cd0c2f1 (diff) | |
| download | cpython-b667e288fc31d73385d46058874421a96e032153.tar.gz | |
#11726: Make linecache docs reflect that all files are treated the same.
Being able to read non-python text files is not a purpose of linecache, but it
does work and people use it. This changeset adjusts the language to make it
clear that Python files are not treated uniquely, but does not go so far as to
say reading non-python files is explicitly supported.
Diffstat (limited to 'Doc/library/linecache.rst')
| -rw-r--r-- | Doc/library/linecache.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/linecache.rst b/Doc/library/linecache.rst index e9ec801763..f18b1cdac0 100644 --- a/Doc/library/linecache.rst +++ b/Doc/library/linecache.rst @@ -14,9 +14,9 @@ attempting to optimize internally, using a cache, the common case where many lines are read from a single file. This is used by the :mod:`traceback` module to retrieve source lines for inclusion in the formatted traceback. -The :func:`tokenize.open` function is used to open Python source files. This +The :func:`tokenize.open` function is used to open files. This function uses :func:`tokenize.detect_encoding` to get the encoding of the -Python source file. +file; in the absence of an encoding token, the file encoding defaults to UTF-8. The :mod:`linecache` module defines the following functions: |